1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <book id="ding.xml" lang="de">
5 <title>Lx-Office: Installation, Konfiguration, Entwicklung</title>
7 <chapter id="Aktuelle-Hinweise">
8 <title>Aktuelle Hinweise</title>
10 <para>Aktuelle Installations- und Konfigurationshinweise gibt es:</para>
14 <para>auf der Lx-Office-Homepage unter <ulink
15 url="http://lx-office.org/index.php?id=dokumentation">http://lx-office.org/index.php?id=dokumentation</ulink></para>
19 <para>im Lx-Office-Wiki unter Dokumentation (<ulink
20 url="http://wiki.lx-office.org/index.php/Lx-Office_ERP">http://wiki.lx-office.org/index.php/Lx-Office_ERP</ulink>)</para>
24 <para>im Lx-Office-Forum: <ulink
25 url="http://www.lx-office.org/forum/">http://www.lx-office.org/forum/</ulink></para>
31 <title>Installation und Grundkonfiguration</title>
33 <sect1 id="Benötigte-Software-und-Pakete">
34 <title>Benötigte Software und Pakete</title>
36 <sect2 id="Betriebssystem">
37 <title>Betriebssystem</title>
39 <para>Lx-Office ist für Linux konzipiert, und sollte auf jedem
40 unixoiden Betriebssystem zum Laufen zu kriegen sein. Getestet ist
41 diese Version im speziellen auf Debian und Ubuntu, grundsätzlich wurde
42 bei der Auswahl der Pakete aber darauf Rücksicht genommen, dass es
43 ohne große Probleme auf den derzeit aktuellen verbreiteten
44 Distributionen läuft.</para>
46 <para>Anfang 2012 sind das folgende Systeme, von denen bekannt ist, dass Lx-Office auf ihnen läuft:</para>
50 <para>Ubuntu 8.04 LTS Hardy Heron, 10.04 LTS Lucid Lynx bis 11.10 Oneiric Ocelot</para>
54 <para>Debian 5.0 Lenny und 6.0 Squeeze</para>
58 <para>openSUSE 11.2 und 11.3</para>
62 <para>SuSE Linux Enterprice Server 11</para>
66 <para>Fedora 13 bis 15</para>
70 <para>Ubuntu 8.04 LTS hat zusätzlich die Schwierigkeit, dass die
71 Module im Archiv recht alt sind, und das viele der benötigten Module
72 nicht einfach zu installieren sind. Dafür sollte es kurz nach dem
73 Release ein eigenes .deb geben.</para>
75 <para>Alternativ dazu kann die normale Installation durchgeführt
77 linkend="Manuelle-Installation-des-Programmpaketes"/>), wenn vorher
78 ein Kompatibilitätspaket installiert wird, das die fehlenden Pakete
79 bereitstellt. Das Paket ist auf <ulink
80 url="https://sourceforge.net/projects/lx-office/files/Lx-Office%20ERP/2.6.2/">Sourceforge</ulink>
81 unter dem Namen <filename>lx-erp-perl-libs-compat-v2.tar.gz</filename>
84 <para>Zur Installation das Paket in das entpackte Lx-Office
85 Verzeichnis entpacken:</para>
87 <programlisting>tar xzf lx-erp-perl-libs-compat-v2.tar.gz /path/to/lx-office/</programlisting>
89 <para>Zusätzlich müssen dann noch die folgenden Pakete installiert
92 <programlisting>apt-get install libbit-vector-perl libsub-exporter-perl libclone-perl libclass-factory-util-perl</programlisting>
94 <para>Danach sollte der Installationscheck (siehe <xref
95 linkend="Pakete"/>) die enthaltenen Pakete erkennen.</para>
98 <sect2 id="Pakete" xreflabel="Pakete">
101 <para>Zum Betrieb von Lx-Office werden zwingend ein Webserver (meist
102 Apache) und ein Datenbankserver (PostgreSQL, mindestens v8.2)
105 <para>Zusätzlich benötigt Lx-Office die folgenden Perl-Pakete, die
106 nicht Bestandteil einer Standard-Perl-Installation sind:</para>
114 <para>Archive::Zip</para>
118 <para>Config::Std</para>
122 <para>DateTime</para>
134 <para>Email::Address</para>
142 <para>List::MoreUtils</para>
146 <para>Params::Validate</para>
150 <para>PDF::API2</para>
154 <para>Rose::Object</para>
158 <para>Rose::DB</para>
162 <para>Rose::DB::Object</para>
166 <para>Template</para>
170 <para>Text::CSV_XS</para>
174 <para>Text::Iconv</para>
182 <para>XML::Writer</para>
190 <para>Gegenüber Version 2.6.0 sind zu dieser Liste 2 Pakete
191 hinzugekommen, <literal>URI</literal> und
192 <literal>XML::Writer</literal> sind notwendig. Ohne startet Lx-Office
195 <para>Gegenüber Version 2.6.1 sind <literal>parent</literal>,
196 <literal>DateTime</literal>, <literal>Rose::Object</literal>,
197 <literal>Rose::DB</literal> und <literal>Rose::DB::Object</literal>
198 neu hinzugekommen. <literal>IO::Wrap</literal> wurde entfernt.</para>
200 <para>Gegenüber Version 2.6.3 ist <literal>JSON</literal> neu
201 hinzugekommen.</para>
203 <para><literal>Email::Address</literal> und
204 <literal>List::MoreUtils</literal> sind schon länger feste
205 Abhängigkeiten, wurden aber bisher mit Lx-Office mitgeliefert. Beide
206 sind auch in 2.6.1 weiterhin mit ausgeliefert, wurden in einer
207 zukünftigen Version aber aus dem Paket entfernt werden. Es wird
208 empfohlen diese Module zusammen mit den anderen als Bibliotheken zu
211 <para>Die zu installierenden Pakete können in den verschiedenen
212 Distributionen unterschiedlich heißen.</para>
214 <para>Für Debian oder Ubuntu benötigen Sie diese Pakete:</para>
216 <programlisting>apt-get install apache2 postgresql libparent-perl libarchive-zip-perl \
217 libdatetime-perl libdbi-perl libdbd-pg-perl libpg-perl \
218 libemail-address-perl liblist-moreutils-perl libpdf-api2-perl \
219 librose-object-perl librose-db-perl librose-db-object-perl \
220 libtemplate-perl libtext-csv-xs-perl libtext-iconv-perl liburi-perl \
221 libxml-writer-perl libyaml-perl libconfig-std-perl \
222 libparams-validate-perl libjson-perl</programlisting>
224 <para>Für Fedora Core benötigen Sie diese Pakete:</para>
226 <programlisting>yum install httpd postgresql-server perl-parent perl-DateTime \
227 perl-DBI perl-DBD-Pg perl-Email-Address perl-List-MoreUtils \
228 perl-PDF-API2 perl-Rose-Object perl-Rose-DB perl-Rose-DB-Object \
229 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv perl-URI \
230 perl-XML-Writer perl-YAML</programlisting>
232 <para>Für OpenSuSE benötigen Sie diese Pakete:</para>
234 <programlisting>zypper install apache2 postgresql-server perl-Archive-Zip \
235 perl-DateTime perl-DBI perl-DBD-Pg perl-MailTools perl-List-MoreUtils \
236 perl-PDF-API2 perl-Template-Toolkit perl-Text-CSV_XS perl-Text-Iconv \
237 perl-URI perl-XML-Writer perl-YAML</programlisting>
239 <para>Bei openSuSE 11 ist <literal>parent</literal> bereits enthalten,
240 und braucht nicht nachinstalliert werden. Die
241 <literal>Rose::*</literal> Pakete sind derzeit nicht für SuSE gepackt,
242 und müssen anderweitig nachinstalliert werden.</para>
244 <para>Lx-Office enthält ein Script, mit dem überprüft werden kann, ob
245 alle benötigten Perl-Module installiert sind. Der Aufruf lautet wie
248 <programlisting>./scripts/installation_check.pl</programlisting>
252 <sect1 id="Manuelle-Installation-des-Programmpaketes"
253 xreflabel="Manuelle Installation des Programmpaketes">
254 <title>Manuelle Installation des Programmpaketes</title>
256 <para>Die Lx-Office ERP Installationsdatei (lxoffice-erp-2.6.3.tgz) wird
257 im Dokumentenverzeichnis des Webservers (z.B.
258 <filename>/var/www/html/</filename>,
259 <filename>/srv/www/htdocs</filename> oder
260 <filename>/var/www/</filename>) entpackt:</para>
262 <programlisting>cd /var/www tar xvzf
263 lxoffice-erp-2.6.2.tgz</programlisting>
265 <para>Verändern Sie evtl. noch den Namen des Verzeichnisses mit</para>
267 <programlisting>mv lxoffice-erp/ lx-erp/</programlisting>
269 <para>Alternativ können Sie auch einen Alias in der
270 Webserverkonfiguration benutzen, um auf das tatsächliche
271 Installationsverzeichnis zu verweisen.</para>
273 <para>Die Verzeichnisse <filename>users</filename>,
274 <filename>spool</filename> und <filename>webdav</filename> müssen für
275 den Benutzer beschreibbar sein, unter dem der Webserver läuft. Die
276 restlichen Dateien müssen für diesen Benutzer lesbar sein. Der
277 Benutzername ist bei verschiedenen Distributionen unterschiedlich (z.B.
278 bei Debian/Ubuntu <constant>www-data</constant>, bei Fedora core
279 <constant>apache</constant> oder bei OpenSuSE
280 <constant>wwwrun</constant>).</para>
282 <para>Der folgende Befehl ändert den Besitzer für die oben genannten
283 Verzeichnisse auf einem Debian/Ubuntu-System:</para>
285 <programlisting>chown -R www-data lx-office-erp/users lx-office-erp/spool lx-office-erp/webdav</programlisting>
287 <para>Weiterhin muss der Webserver-Benutzer im Verzeichnis
288 <filename>templates</filename> Verzeichnisse für jeden neuen Benutzer,
289 der in lx-office angelegt wird, anlegen dürfen:</para>
291 <programlisting>chgrp www-data lx-office-erp/templates
292 chmod g+w lx-office-erp/templates</programlisting>
295 <sect1 id="config.config-file">
296 <title>Lx-Office-Konfigurationsdatei</title>
298 <sect2 id="config.config-file.introduction" xreflabel="Einführung in die Konfigurationsdatei">
299 <title>Einführung</title>
302 Seit Lx-Office 2.6.3. gibt es nur noch eine Konfigurationsdatei die benötigt wird: <filename>config/lx_office.conf</filename> (kurz:
303 "die Hauptkonfigurationsdatei"). Diese muss bei der Erstinstallation von Lx-Office bzw. der Migration von älteren Versionen angelegt
308 Als Vorlage dient die Datei <filename>config/lx_office.conf.default</filename> (kurz: "die Default-Datei"):
311 <programlisting>$ cp config/lx_office.conf.default config/lx_office.conf</programlisting>
314 Die Default-Datei wird immer zuerst eingelesen. Werte, die in der Hauptkonfigurationsdatei stehen, überschreiben die
315 Werte aus der Default-Datei. Die Hauptkonfigurationsdatei muss also nur die Abschintte und Werte
316 enthalten, die von denen der Default-Datei abweichen.
320 Diese Hauptkonfigurationsdatei ist dann eine installationsspezifische Datei, d.h. sie enthält bspw. lokale Passwörter und wird auch
321 nicht im Versionsmanagement (git) verwaltet.
325 Die Konfiguration ist ferner serverabhängig, d.h. für alle Mandaten, bzw. Datenbanken gleich.
329 <sect2 id="config.config-file.sections-parameters">
330 <title>Abschnitte und Parameter</title>
333 Die Konfigurationsdatei besteht aus mehreren Teilen, die entsprechend kommentiert sind:
337 <listitem><para><literal>authentication</literal></para></listitem>
338 <listitem><para><literal>authentication/database</literal></para></listitem>
339 <listitem><para><literal>authentication/ldap</literal></para></listitem>
340 <listitem><para><literal>system</literal></para></listitem>
341 <listitem><para><literal>features</literal></para></listitem>
342 <listitem><para><literal>paths</literal></para></listitem>
343 <listitem><para><literal>applications</literal></para></listitem>
344 <listitem><para><literal>environment</literal></para></listitem>
345 <listitem><para><literal>print_templates</literal></para></listitem>
346 <listitem><para><literal>task_server</literal></para></listitem>
347 <listitem><para><literal>periodic_invoices</literal></para></listitem>
348 <listitem><para><literal>console</literal></para></listitem>
349 <listitem><para><literal>debug</literal></para></listitem>
353 Die üblicherweise wichtigsten Parameter, die am Anfang einzustellen oder zu kontrollieren sind, sind:
356 <programlisting>[authentication]
357 admin_password = geheim
359 [authentication/database]
368 dbcharset = UTF-8</programlisting>
371 Nutzt man wiederkehrende Rechnungen, kann man unter <varname>[periodic_invoices]</varname> den Login eines Benutzers angeben, der
372 nach Erstellung der Rechnungen eine entsprechende E-Mail mit Informationen über die erstellten Rechnungen bekommt.
376 Nutzt man den <link linkend="config.task-server">Taskserver</link> für <link
377 linkend="features.periodic-invoices">wiederkehrende Rechnungen</link>, muss unter <varname>[task_server]</varname> ein Login eines
378 Benutzers angegeben werden, mit dem sich der Taskserver an Lx-Office bei der Datenbank anmeldet, die dem Benutzer zugewiesen ist.
382 Für Entwickler finden sich unter <varname>[debug]</varname> wichtige Funktionen, um die Fehlersuche zu erleichtern.
386 <sect2 id="config.config-file.prior-versions">
387 <title>Versionen vor 2.6.3</title>
390 In älteren Lx-Office Versionen gab es im Verzeichnis <filename>config</filename> die Dateien <filename>authentication.pl</filename>
391 und <filename>lx-erp.conf</filename>, die jeweils Perl-Dateien waren. Es gab auch die Möglichkeit, eine lokale Version der
392 Konfigurationsdatei zu erstellen (<filename>lx-erp-local.conf</filename>). Dies ist ab 2.6.3 nicht mehr möglich, aber auch nicht mehr
397 Beim Update von einer Lx-Office-Version vor 2.6.3 auf 2.6.3 oder jünger müssen die Einstellungen aus den alten Konfigurationsdateien
398 manuell übertragen und die alten Konfigurationsdateien anschließend gelöscht oder verschoben werden. Ansonsten zeigt Lx-Office eine
399 entsprechende Fehlermeldung an.
404 <sect1 id="Anpassung-der-PostgreSQL-Konfiguration">
405 <title>Anpassung der PostgreSQL-Konfiguration</title>
407 <para>PostgreSQL muss auf verschiedene Weisen angepasst werden.</para>
409 <sect2 id="Zeichensätze-die-Verwendung-von-UTF-8">
410 <title>Zeichensätze/die Verwendung von UTF-8</title>
412 <para>Lx-Office kann komplett mit UTF-8 als Zeichensatz verwendet
413 werden. Dabei gibt es zwei Punkte zu beachten: PostgreSQL muss in
414 Version 8.2 oder neuer benutzt werden, und der
415 PostgreSQL-Datenbankcluster muss ebenfalls mit UTF-8 als Locale
416 angelegt worden sein.</para>
418 <para>Dieses ist kann überprüft werden: ist das Encoding der Datenbank “template1” “UTF8”, so kann auch Lx-Office mit UTF-8
419 betrieben werden. Andernfalls ist es notwendig, einen neuen Datenbankcluster mit UTF-8-Encoding anzulegen und diesen zu
420 verwenden. Unter Debian und Ubuntu kann dies z.B. für PostgreSQL 8.2 mit dem folgenden Befehl getan werden:</para>
422 <programlisting>pg_createcluster --locale=de_DE.UTF-8 --encoding=UTF-8 8.2 clustername</programlisting>
424 <para>Die Datenbankversionsnummer muss an die tatsächlich verwendete Versionsnummer angepasst werden.</para>
426 <para>Unter anderen Distributionen gibt es ähnliche Methoden.</para>
428 <para>Wurde PostgreSQL nicht mit UTF-8 als Encoding initialisiert und
429 ist ein Neuanlegen eines weiteren Clusters nicht möglich, so kann
430 Lx-Office mit ISO-8859-15 als Encoding betrieben werden.</para>
432 <para>Das Encoding einer Datenbank kann in <command>psql</command> mit <literal>\l</literal> geprüft werden.</para>
435 <sect2 id="Änderungen-an-Konfigurationsdateien">
436 <title>Änderungen an Konfigurationsdateien</title>
438 <para>In der Datei <filename>postgresql.conf</filename>, die je nach
439 Distribution in verschiedenen Verzeichnissen liegen kann (z.B.
440 <filename>/var/lib/pgsql/data/</filename> oder
441 <filename>/etc/postgresql/</filename>, muss sichergestellt werden, dass
442 TCP/IP-Verbindungen aktiviert sind. Das Verhalten wird über den
443 Parameter <varname>listen_address</varname> gesteuert. Laufen
444 PostgreSQL und Lx-Office auf demselben Rechner, so kann dort der Wert
445 <literal>localhost</literal> verwendet werden. Andernfalls müssen
446 Datenbankverbindungen auch von anderen Rechnern aus zugelassen werden,
447 was mit dem Wert <literal>*</literal> geschieht.</para>
449 <para>In der Datei <filename>pg_hba.conf</filename>, die im gleichen
450 Verzeichnis wie die <filename>postgresql.conf</filename> zu finden sein
451 sollte, müssen die Berichtigungen für den Zugriff geändert werden.
452 Hier gibt es mehrere Möglichkeiten. Eine besteht darin, lokale
453 Verbindungen immer zuzulassen:</para>
455 <programlisting>local all all trust
456 host all all 127.0.0.1 255.0.0.0 trust</programlisting>
458 <para>Besser ist es, für eine bestimmte Datenbank Zugriff nur per
459 Passwort zuzulassen. Beispielsweise:</para>
461 <programlisting>local all lxoffice password
462 host all lxoffice 127.0.0.1 255.255.255.255 password</programlisting>
465 <sect2 id="Erweiterung-für-servergespeicherte-Prozeduren">
466 <title>Erweiterung für servergespeicherte Prozeduren</title>
468 <para>In der Datenbank <literal>template1</literal> muss die
469 Unterstützung für servergespeicherte Prozeduren eingerichet werden.
470 Melden Sie sich dafür als Benutzer “postgres” an der Datenbank an, und
471 führen Sie die folgenden Kommandos aus:</para>
473 <programlisting>create language 'plpgsql';</programlisting>
476 <sect2 id="Datenbankbenutzer-anlegen">
477 <title>Datenbankbenutzer anlegen</title>
479 <para>Wenn Sie nicht den Datenbanksuperuser “postgres” zum Zugriff
480 benutzen wollen, so sollten Sie bei PostgreSQL einen neuen Benutzer
481 anlegen. Ein Beispiel, wie Sie einen neuen Benutzer anlegen
484 <programlisting>su - postgres createuser -d -P lxoffice</programlisting>
486 <para>Wenn Sie später einen Datenbankzugriff konfigurieren, verändern
487 Sie den evtl. voreingestellten Benutzer “postgres” auf “lxoffice” bzw.
488 den hier gewählten Benutzernamen.</para>
492 <sect1 id="Apache-Konfiguration">
493 <title>Webserver-Konfiguration</title>
496 <title>Grundkonfiguration mittels CGI</title>
499 <para>Für einen deutlichen Performanceschub sorgt die Ausführung
500 mittels FastCGI/FCGI. Die Einrichtung wird ausführlich im Abschnitt
501 <xref linkend="Apache-Konfiguration.FCGI"/> beschrieben.</para>
504 <para>Der Zugriff auf das Programmverzeichnis muss in der Apache
505 Webserverkonfigurationsdatei <literal>httpd.conf</literal> eingestellt
506 werden. Fügen Sie den folgenden Abschnitt dieser Datei oder einer
507 anderen Datei hinzu, die beim Starten des Webservers eingelesen
510 <programlisting>AddHandler cgi-script .pl
511 Alias /lx-erp/ /var/www/lx-erp/
513 <Directory /var/www/lx-erp>
515 Includes FollowSymlinks
518 <Directory /var/www/lx-erp/users>
521 </Directory></programlisting>
523 <para>Ersetzen Sie dabei die Pfade durch diejenigen, in die Sie vorher
524 das Lx-Office-Archiv entpacket haben.</para>
527 <para>Vor den einzelnen Optionen muss bei einigen Distributionen ein Plus ‘<literal>+</literal>’ gesetzt werden.</para>
530 <para>Auf einigen Webservern werden manchmal die Grafiken und
531 Style-Sheets nicht ausgeliefert. In solchen Fällen hat es oft
532 geholfen, die folgende Option in die Konfiguration aufzunehmen:</para>
534 <programlisting>EnableSendfile Off</programlisting>
537 <sect2 id="Apache-Konfiguration.FCGI"
538 xreflabel="Konfiguration für FastCGI/FCGI">
539 <title>Konfiguration für FastCGI/FCGI</title>
541 <sect3 id="Apache-Konfiguration.FCGI.WasIstEs">
542 <title>Was ist FastCGI?</title>
544 <para>Direkt aus <ulink
545 url="http://de.wikipedia.org/wiki/FastCGI">Wikipedia</ulink>
548 <para><citation> FastCGI ist ein Standard für die Einbindung
549 externer Software zur Generierung dynamischer Webseiten in einem
550 Webserver. FastCGI ist vergleichbar zum Common Gateway Interface
551 (CGI), wurde jedoch entwickelt, um dessen Performance-Probleme zu
552 umgehen. </citation></para>
555 <sect3 id="Apache-Konfiguration.FCGI.Warum">
556 <title>Warum FastCGI?</title>
558 <para>Perl Programme (wie Lx-Office eines ist) werden nicht statisch
559 kompiliert. Stattdessen werden die Quelldateien bei jedem Start
560 übersetzt, was bei kurzen Laufzeiten einen Großteil der Laufzeit
561 ausmacht. Während SQL Ledger einen Großteil der Funktionalität in
562 einzelne Module kapselt, um immer nur einen kleinen Teil laden zu
563 müssen, ist die Funktionalität von Lx-Office soweit gewachsen, dass
564 immer mehr Module auf den Rest des Programms zugreifen. Zusätzlich
565 benutzen wir umfangreiche Bibliotheken um Funktionaltät nicht selber
566 entwickeln zu müssen, die zusätzliche Ladezeit kosten. All dies
567 führt dazu dass ein Lx-Office Aufruf der Kernmasken mittlerweile
568 deutlich länger dauert als früher, und dass davon 90% für das Laden
569 der Module verwendet wird.</para>
571 <para>Mit FastCGI werden nun die Module einmal geladen, und danach
572 wird nur die eigentliche Programmlogik ausgeführt.</para>
575 <sect3 id="Apache-Konfiguration.FCGI.WebserverUndPlugin">
576 <title>Getestete Kombinationen aus Webservern und Plugin</title>
578 <para>Folgende Kombinationen sind getestet:</para>
582 <para>Apache 2.2.11 (Ubuntu) und mod_fcgid.</para>
586 <para>Apache 2.2.11 (Ubuntu) und mod_fastcgi.</para>
590 <para>Dabei wird mod_fcgid empfohlen, weil mod_fastcgi seit geraumer
591 Zeit nicht mehr weiter entwickelt wird. Im Folgenden wird auf
592 mod_fastcgi nicht mehr explizit eingegangen.</para>
594 <para>Als Perl Backend wird das Modul <filename>FCGI.pm</filename>
599 FCGI 0.69 und höher ist extrem strict in der Behandlung von Unicode, und verweigert bestimmte Eingaben von Lx-Office. Falls es
600 Probleme mit Umlauten in Ihrere Installation gibt, muss auf die Vorgängerversion FCGI 0.68 ausgewichen werden.
604 Mit CPAN lässt sie sich die Vorgängerversion wie folgt installieren:
607 <programlisting>force install M/MS/MSTROUT/FCGI-0.68.tar.gz</programlisting>
611 <sect3 id="Apache-Konfiguration.FCGI.Konfiguration">
612 <title>Konfiguration des Webservers</title>
614 <para>Bevor Sie versuchen, eine Lx-Office Installation unter FCGI
615 laufen zu lassen, empfliehlt es sich die Installation ersteinmal
616 unter CGI aufzusetzen. FCGI macht es nicht einfach Fehler zu
617 debuggen die beim ersten aufsetzen auftreten können. Sollte die
618 Installation schon funktionieren, lesen Sie weiter.</para>
620 <para>Zuerst muss das FastCGI-Modul aktiviert werden. Dies kann
621 unter Debian/Ubuntu z.B. mit folgendem Befehl geschehen:</para>
623 <programlisting>a2enmod fcgid</programlisting>
625 <para>Die Konfiguration für die Verwendung von Lx-Office mit FastCGI
626 erfolgt durch Anpassung der vorhandenen <function>Alias</function>-
627 und <function>Directory</function>-Direktiven. Dabei wird zwischen
628 dem Installationspfad von Lx-Office im Dateisystem
629 ("<filename>/path/to/lx-office-erp</filename>") und der URL
630 unterschieden, unter der Lx-Office im Webbrowser erreichbar ist
631 ("<filename>/url/for/lx-office-erp</filename>").</para>
633 <para>Folgender Konfigurationsschnipsel funktioniert mit
636 <programlisting>AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fcgi
637 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
639 <Directory /path/to/lx-office-erp>
641 Options ExecCGI Includes FollowSymlinks
646 <DirectoryMatch /path/to/lx-office-erp/users>
649 </DirectoryMatch></programlisting>
651 <para>Seit mod_fcgid-Version 2.6.3 gelten sehr kleine Grenzen für
652 die maximale Größe eines Requests. Diese sollte wie folgt
653 hochgesetzt werden:</para>
655 <programlisting>FcgidMaxRequestLen 10485760</programlisting>
657 <para>Das ganze sollte dann so aussehen:</para>
659 <programlisting>AddHandler fcgid-script .fpl
660 AliasMatch ^/url/for/lx-office-erp/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
661 Alias /url/for/lx-office-erp/ /path/to/lx-office-erp/
662 FcgidMaxRequestLen 10485760
664 <Directory /path/to/lx-office-erp>
666 Options ExecCGI Includes FollowSymlinks
671 <DirectoryMatch /path/to/lx-office-erp/users>
674 </DirectoryMatch></programlisting>
676 <para>Hierdurch wird nur ein zentraler Dispatcher gestartet. Alle
677 Zugriffe auf die einzelnen Scripte werden auf diesen umgeleitet.
678 Dadurch, dass zur Laufzeit öfter mal Scripte neu geladen werden,
679 gibt es hier kleine Performance-Einbußen.</para>
681 <para>Es ist möglich, die gleiche Lx-Office Version parallel unter
682 CGI und FastCGI zu betreiben. Dafür bleiben die Directorydirektiven
683 wie oben beschrieben, die URLs werden aber umgeleitet:</para>
685 <programlisting># Zugriff über CGI
686 Alias /url/for/lx-office-erp /path/to/lx-office-erp
688 # Zugriff mit mod_fcgid:
689 AliasMatch ^/url/for/lx-office-erp-fcgid/[^/]+\.pl /path/to/lx-office-erp/dispatcher.fpl
690 Alias /url/for/lx-office-erp-fcgid/ /path/to/lx-office-erp/</programlisting>
692 <para>Dann ist unter <filename>/url/for/lx-office-erp/</filename> die normale Version erreichbar, und unter
693 <constant>/url/for/lx-office-erp-fcgid/</constant> die FastCGI-Version.</para>
698 <sect1 id="config.task-server">
699 <title>Der Task-Server</title>
701 <para>Der Task-Server ist ein Prozess, der im Hintergrund läuft, in
702 regelmäßigen Abständen nach abzuarbeitenden Aufgaben sucht und diese zu
703 festgelegten Zeitpunkten abarbeitet (ähnlich wie Cron). Dieser Prozess
704 wird bisher nur für die Erzeugung der wiederkehrenden Rechnungen
705 benutzt, wird aber in Zukunft deutlich mehr Aufgaben übertragen
708 <sect2 id="Konfiguration-des-Task-Servers">
709 <title>Verfügbare und notwendige Konfigurationsoptionen</title>
711 <para>Die Konfiguration erfolgt über den Abschnitt
712 <literal>[task_server]</literal> in der Datei
713 <filename>config/lx_office.conf</filename>. Die dort verfügbaren
714 Optionen sind:</para>
718 <term><varname>login</varname></term>
721 gültiger Lx-Office-Benutzername, der benutzt wird, um die zu verwendende Datenbankverbindung auszulesen. Der Benutzer muss in
722 der Administration angelegt werden. Diese Option muss angegeben werden.
728 <term><varname>run_as</varname></term>
731 Wird der Server vom Systembenutzer <literal>root</literal> gestartet, so wechselt er auf den mit <literal>run_as</literal>
732 angegebenen Systembenutzer. Der Systembenutzer muss dieselben Lese- und Schreibrechte haben, wie auch der Webserverbenutzer
733 (siehe see <xref linkend="Manuelle-Installation-des-Programmpaketes"/>). Daher ist es sinnvoll, hier denselben Systembenutzer
734 einzutragen, unter dem auch der Webserver läuft.
740 <term><varname>debug</varname></term>
743 Schaltet Debug-Informationen an und aus.
750 <sect2 id="Einbinden-in-den-Boot-Prozess">
751 <title>Automatisches Starten des Task-Servers beim Booten</title>
753 <para>Der Task-Server verhält sich von seinen Optionen her wie ein
754 reguläres SystemV-kompatibles Boot-Script. Außerdem wechselt er beim
755 Starten automatisch in das Lx-Office-Installationsverzeichnis.</para>
757 <para>Deshalb ist es möglich, ihn durch Setzen eines symbolischen
758 Links aus einem der Runlevel-Verzeichnisse heraus in den Boot-Prozess
759 einzubinden. Da das bei neueren Linux-Distributionen aber nicht
760 zwangsläufig funktioniert, werden auch Start-Scripte mitgeliefert, die
761 anstelle eines symbolischen Links verwendet werden können.</para>
764 <title>SystemV-basierende Systeme (z.B. Debian, OpenSuSE, Fedora
767 <para>Kopieren Sie die Datei
768 <filename>scripts/boot/system-v/lx-office-task-server</filename>
769 nach <filename>/etc/init.d/lx-office-task-server</filename>. Passen
770 Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
771 <literal>DAEMON=....</literal>). Binden Sie das Script in den
772 Boot-Prozess ein. Dies ist distributionsabhängig:</para>
776 <para>Debian-basierende Systeme:</para>
778 <programlisting>update-rc.d lx-office-task-server defaults
779 # Nur bei Debian Squeeze und neuer:
780 insserv lx-office-task-server</programlisting>
784 <para>OpenSuSE und Fedora Core:</para>
786 <programlisting>chkconfig --add lx-office-task-server</programlisting>
790 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: <command>/etc/init.d/lx-office-task-server
791 start</command></para>
795 <title>Upstart-basierende Systeme (z.B. Ubuntu)</title>
797 <para>Kopieren Sie die Datei
798 <filename>scripts/boot/upstart/lx-office-task-server.conf</filename>
799 nach <filename>/etc/init/lx-office-task-server.conf</filename>.
800 Passen Sie in der kopierten Datei den Pfad zum Task-Server an (Zeile
801 <literal>exec ....</literal>).</para>
803 <para>Danach kann der Task-Server mit dem folgenden Befehl gestartet werden: <command>service lx-office-task-server
804 start</command></para>
808 <sect2 id="Prozesskontrolle">
809 <title>Wie der Task-Server gestartet und beendet wird</title>
811 <para>Der Task-Server wird wie folgt kontrolliert:</para>
813 <programlisting>./scripts/task_server.pl Befehl</programlisting>
815 <para><literal>Befehl</literal> ist dabei eine der folgenden
820 <para><literal>start</literal> startet eine neue Instanz des
821 Task-Servers. Die Prozess-ID wird innerhalb des
822 <filename>users</filename>-Verzeichnisses abgelegt.</para>
826 <para><literal>stop</literal> beendet einen laufenden
831 <para><literal>restart</literal> beendet und startet ihn
836 <para><literal>status</literal> berichtet, ob der Task-Server
841 <para>Der Task-Server wechselt beim Starten automatisch in das
842 Lx-Office-Installationsverzeichnis.</para>
844 <para>Dieselben Optionen können auch für die SystemV-basierenden
845 Runlevel-Scripte benutzt werden (siehe oben).</para>
849 <sect1 id="Benutzerauthentifizierung-und-Administratorpasswort">
850 <title>Benutzerauthentifizierung und Administratorpasswort</title>
852 <para>Informationen über die Einrichtung der Benutzerauthentifizierung,
853 über die Verwaltung von Gruppen und weitere Einstellungen</para>
855 <sect2 id="Grundlagen-zur-Benutzerauthentifizierung">
856 <title>Grundlagen zur Benutzerauthentifizierung</title>
858 <para>Lx-Office verwaltet die Benutzerinformationen in einer
859 Datenbank, die im folgenden “Authentifizierungsdatenbank” genannt
860 wird. Für jeden Benutzer kann dort eine eigene Datenbank für die
861 eigentlichen Finanzdaten hinterlegt sein. Diese beiden Datenbanken
862 können, müssen aber nicht unterschiedlich sein.</para>
864 <para>Im einfachsten Fall gibt es für Lx-Office nur eine einzige
865 Datenbank, in der sowohl die Benutzerinformationen als auch die Daten
866 abgelegt werden.</para>
868 <para>Zusätzlich ermöglicht es Lx-Office, dass die Benutzerpasswörter
869 entweder gegen die Authentifizierungsdatenbank oder gegen einen
870 LDAP-Server überprüft werden.</para>
872 <para>Welche Art der Passwortüberprüfung Lx-Office benutzt und wie
873 Lx-Office die Authentifizierungsdatenbank erreichen kann, wird in der
874 Konfigurationsdatei <filename>config/lx_office.conf</filename>
875 festgelegt. Diese muss bei der Installation und bei einem Upgrade von
876 einer Version vor v2.6.0 angelegt werden. Eine
877 Beispielkonfigurationsdatei
878 <filename>config/lx_office.conf.default</filename> existiert, die als
879 Vorlage benutzt werden kann.</para>
882 <sect2 id="Administratorpasswort">
883 <title>Administratorpasswort</title>
885 <para>Das Passwort, das zum Zugriff auf das Aministrationsinterface benutzt wird, wird ebenfalls in dieser Datei gespeichert. Es
886 kann auch nur dort und nicht mehr im Administrationsinterface selber geändert werden. Der Parameter dazu heißt
887 <varname>admin_password</varname> im Abschnitt <varname>[authentication]</varname>.</para>
890 <sect2 id="Authentifizierungsdatenbank">
891 <title>Authentifizierungsdatenbank</title>
893 <para>Die Verbindung zur Authentifizierungsdatenbank wird mit den Parametern in <varname>[authentication/database]</varname>
894 konfiguriert. Hier sind die folgenden Parameter anzugeben:</para>
898 <term><literal>host</literal></term>
900 <para>Der Rechnername oder die IP-Adresse des Datenbankservers</para>
905 <term><literal>port</literal></term>
907 <para>Die Portnummer des Datenbankservers, meist 5432</para>
912 <term><literal>db</literal></term>
914 <para>Der Name der Authentifizierungsdatenbank</para>
919 <term><literal>user</literal></term>
921 <para>Der Benutzername, mit dem sich Lx-Office beim Datenbankserver anmeldet (z.B. "<literal>postgres</literal>")</para>
926 <term><literal>password</literal></term>
928 <para>Das Passwort für den Datenbankbenutzer</para>
933 <para>Die Datenbank muss noch nicht existieren. Lx-Office kann sie
934 automatisch anlegen (mehr dazu siehe unten).</para>
937 <sect2 id="Passwortüberprüfung">
938 <title>Passwortüberprüfung</title>
940 <para>Lx-Office unterstützt Passwortüberprüfung auf zwei Arten: gegen die Authentifizierungsdatenbank und gegen einen externen LDAP-
941 oder Active-Directory-Server. Welche davon benutzt wird, regelt der Parameter <varname>module</varname> im Abschnitt
942 <varname>[authentication]</varname>.</para>
944 <para>Sollen die Benutzerpasswörter in der Authentifizierungsdatenbank gespeichert werden, so muss der Parameter
945 <varname>module</varname> den Wert <literal>DB</literal> enthalten. In diesem Fall können sowohl der Administrator als auch die
946 Benutzer selber ihre Psaswörter in Lx-Office ändern.</para>
948 <para>Soll hingegen ein externer LDAP- oder Active-Directory-Server benutzt werden, so muss der Parameter <varname>module</varname>
949 auf <literal>LDAP</literal> gesetzt werden. In diesem Fall müssen zusätzliche Informationen über den LDAP-Server im Abschnitt
950 <literal>[authentication/ldap]</literal> angegeben werden:</para>
954 <term><literal>host</literal></term>
956 <para>Der Rechnername oder die IP-Adresse des LDAP- oder Active-Directory-Servers. Diese Angabe ist zwingend
962 <term><literal>port</literal></term>
964 <para>Die Portnummer des LDAP-Servers; meist 389.</para>
969 <term><literal>tls</literal></term>
971 <para>Wenn Verbindungsverschlüsselung gewünscht ist, so diesen Wert auf ‘<literal>1</literal>’ setzen, andernfalls auf
972 ‘<literal>0</literal>’ belassen</para>
977 <term><literal>attribute</literal></term>
979 <para>Das LDAP-Attribut, in dem der Benutzername steht, den der Benutzer eingegeben hat. Für Active-Directory-Server ist dies
980 meist ‘<literal>sAMAccountName</literal>’, für andere LDAP-Server hingegen ‘<literal>uid</literal>’. Diese Angabe ist zwingend
986 <term><literal>base_dn</literal></term>
988 <para>Der Abschnitt des LDAP-Baumes, der durchsucht werden soll. Diese Angabe ist zwingend erforderlich.</para>
993 <term><literal>filter</literal></term>
995 <para>Ein optionaler LDAP-Filter. Enthält dieser Filter das Wort <literal><%login%></literal>, so wird dieses durch den
996 vom Benutzer eingegebenen Benutzernamen ersetzt. Andernfalls wird der LDAP-Baum nach einem Element durchsucht, bei dem das oben
997 angegebene Attribut mit dem Benutzernamen identisch ist.</para>
1002 <term><literal>bind_dn</literal> und <literal>bind_password</literal></term>
1004 <para>Wenn der LDAP-Server eine Anmeldung erfordert, bevor er durchsucht werden kann (z.B. ist dies bei Active-Directory-Servern
1005 der Fall), so kann diese hier angegeben werden. Für Active-Directory-Server kann als ‘<literal>bind_dn</literal>’ entweder eine
1006 komplette LDAP-DN wie z.B. ‘<literal>cn=Martin Mustermann,cn=Users,dc=firmendomain</literal>’ auch nur der volle Name des
1007 Benutzers eingegeben werden; in diesem Beispiel also ‘<literal>Martin Mustermann</literal>’.</para>
1013 <sect2 id="Name-des-Session-Cookies">
1014 <title>Name des Session-Cookies</title>
1016 <para>Sollen auf einem Server mehrere Lx-Office-Installationen aufgesetzt werden, so müssen die Namen der Session-Cookies für alle
1017 Installationen unterschiedlich sein. Der Name des Cookies wird mit dem Parameter <varname>cookie_name</varname> im Abschnitt
1018 <varname>[authentication]</varname>gesetzt.</para>
1020 <para>Diese Angabe ist optional, wenn nur eine Installation auf dem
1021 Server existiert.</para>
1024 <sect2 id="Anlegen-der-Authentifizierungsdatenbank">
1025 <title>Anlegen der Authentifizierungsdatenbank</title>
1027 <para>Nachdem alle Einstellungen in
1028 <filename>config/lx_office.conf</filename> vorgenommen wurden, muss
1029 Lx-Office die Authentifizierungsdatenbank anlegen. Dieses geschieht
1030 automatisch, wenn Sie sich im Administrationsmodul anmelden, das unter
1031 der folgenden URL erreichbar sein sollte:</para>
1034 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1038 <sect1 id="Benutzer--und-Gruppenverwaltung">
1039 <title>Benutzer- und Gruppenverwaltung</title>
1041 <para>Nach der Installation müssen Benutzer, Gruppen und Datenbanken
1042 angelegt werden. Dieses geschieht im Administrationsmenü, das Sie unter
1043 folgender URL finden:</para>
1046 url="http://localhost/lx-erp/admin.pl">http://localhost/lx-erp/admin.pl</ulink></para>
1048 <para>Verwenden Sie zur Anmeldung das Password, dass Sie in der Datei
1049 <filename>config/lx_office.conf</filename> eingetragen haben.</para>
1051 <sect2 id="Zusammenhänge">
1052 <title>Zusammenhänge</title>
1054 <para>Lx-Office verwendet eine Datenbank zum Speichern all seiner
1055 Informationen wie Kundendaten, Artikel, Angebote, Rechnungen etc. Um
1056 mit Lx-Office arbeiten zu können, muss eine Person einen
1057 Benutzeraccount haben. Jedem Benutzeraccount wiederum wird genau eine
1058 Datenbank zugewiesen, mit der dieser Benutzer arbeiten kann. Es ist
1059 möglich und normal, dass mehreren Benutzern die selbe Datenbank
1060 zugewiesen wird, sodass sie alle mit den selben Daten arbeiten
1063 <para>Die Basisdaten der Benutzer, die in der Administration
1064 eingegeben werden können, werden in einer zweiten Datenbank
1065 gespeichert, der bereits erwähnten Authentifizierungsdatenbank. Diese
1066 ist also den Produktivdaten enthaltenden Datenbanken vorgeschaltet.
1067 Pro Lx-Office-Installation gibt es nur eine
1068 Authentifizierungsdatenbank, aber beliebig viele Datenbanken mit
1071 <para>Lx-Office kann seinen Benutzern Zugriff auf bestimmte
1072 Funktionsbereiche erlauben oder verbieten. Wird der Zugriff nicht
1073 gestattet, so werden der entsprechenden Menüpunkte auch nicht
1074 angezeigt. Diese Rechte werden ebenfalls in der
1075 Authentifizierungsdatenbank gespeichert.</para>
1077 <para>Um Rechte verteilen zu können, verwendet Lx-Office ein
1078 Gruppen-Prinzip. Einer Gruppe kann der Zugriff auf bestimmte Bereiche
1079 erlaubt werden. Ein Benutzer wiederum kann Mitglied in einer oder
1080 mehrerer Gruppen sein. Der Benutzer hat Zugriff auf alle diejenigen
1081 Funktionen, die mindestens einer Gruppe erlaubt sind, in der der
1082 Benutzer Mitglied ist.</para>
1084 <para>Die allgemeine Reihenfolge, in der Datenbanken, Gruppen und
1085 Benutzer angelegt werden sollten, lautet:</para>
1087 <orderedlist numeration="arabic">
1089 <para>Datenbank anlegen</para>
1093 <para>Gruppen anlegen</para>
1097 <para>Benutzer anlegen</para>
1101 <para>Benutzer den Gruppen zuordnen</para>
1106 <sect2 id="Datenbanken-anlegen">
1107 <title>Datenbanken anlegen</title>
1109 <para>Zuerst muss eine Datenbank angelegt werden. Verwenden Sie für
1110 den Datenbankzugriff den vorhin angelegten Benutzer (in unseren
1111 Beispielen ist dies ‘<literal>lxoffice</literal>’).</para>
1113 <para>Wenn Sie für die Lx-Office-Installation nicht den europäischen
1114 Schriftsatz ISO-8859-15 sondern UTF-8 (Unicode) benutzen wollen, so
1115 müssen Sie vor dem Anlegen der Datenbank in der Datei
1116 <filename>config/lx_office.conf</filename> die Variable
1117 <literal>dbcharset</literal> im Abschnitt <literal>system</literal>
1118 auf den Wert ‘<literal>UTF-8</literal>’ setzen. Zusätzlich muss beim
1119 Anlegen der Datenbank ‘<literal>UTF-8 Unicode</literal>’ als
1120 Schriftsatz ausgewählt werden.</para>
1122 <para>Bitte beachten Sie, dass alle Datenbanken den selben Zeichensatz
1123 verwenden müssen, da diese Einstellungen momentan global in Lx-Office
1124 vorgenommen wird und nicht nach Datenbank unterschieden werden kann.
1125 Auch die Authentifizierungsdatenbank muss mit diesem Zeichensatz
1126 angelegt worden sein.</para>
1129 <sect2 id="Gruppen-anlegen">
1130 <title>Gruppen anlegen</title>
1132 <para>Eine Gruppe wird in der Gruppenverwaltung angelegt. Ihr muss ein
1133 Name gegeben werden, eine Beschreibung ist hingegen optional. Nach dem
1134 Anlegen können Sie die verschiedenen Bereiche wählen, auf die
1135 Mitglieder dieser Gruppe Zugriff haben sollen.</para>
1137 <para>Benutzergruppen sind unabhängig von Datenbanken, da sie in der
1138 Authentifizierungsdatenbank gespeichert werden. Sie gelten für alle
1139 Datenbanken, die in dieser Installation verwaltet werden.</para>
1142 <sect2 id="Benutzer-anlegen">
1143 <title>Benutzer anlegen</title>
1145 <para>Beim Anlegen von Benutzern werden für viele Parameter
1146 Standardeinstellungen vorgenommen, die den Gepflogenheiten des
1147 deutschen Raumes entsprechen.</para>
1149 <para>Zwingend anzugeben sind der Loginname sowie die komplette
1150 Datenbankkonfiguration. Wenn die Passwortauthentifizierung über die
1151 Datenbank eingestellt ist, so kann hier auch das Benutzerpasswort
1152 gesetzt bzw. geändert werden. Ist hingegen die LDAP-Authentifizierung
1153 aktiv, so ist das Passwort-Feld deaktiviert.</para>
1155 <para>In der Datenbankkonfiguration müssen die Zugriffsdaten einer der
1156 eben angelegten Datenbanken eingetragen werden.</para>
1159 <sect2 id="Gruppenmitgliedschaften-verwalten">
1160 <title>Gruppenmitgliedschaften verwalten</title>
1162 <para>Nach dem Anlegen von Benutzern und Gruppen müssen Benutzer den
1163 Gruppen zugewiesen werden. Dazu gibt es zwei Möglichkeiten:</para>
1165 <orderedlist numeration="arabic">
1167 <para>In der Gruppenverwaltung wählt man eine Gruppe aus. Im
1168 folgenden Dialog kann man dann einzeln die Benutzer der Gruppe
1173 <para>In der Gruppenverwaltung wählt man das Tool zur Verwaltung
1174 der Gruppenmitgliedschaft. Hier wird eine Matrix angezeigt, die
1175 alle im System angelegten Gruppen und Benutzer enthält. Durch
1176 Setzen der Häkchen wird der Benutzer in der ausgewählten Zeile der
1177 Gruppe in der ausgewählten Spalte hinzugefügt.</para>
1182 <sect2 id="Migration-alter-Installationen">
1183 <title>Migration alter Installationen</title>
1185 <para>Wenn Lx-Office 2.6.2 über eine ältere Version installiert wird,
1186 in der die Benutzerdaten noch im Dateisystem im Verzeichnis
1187 <literal>users</literal> verwaltet wurden, so bietet Lx-Office die
1188 Möglichkeit, diese Benutzerdaten automatisch in die
1189 Authentifizierungsdatenbank zu übernehmen. Dies geschieht, wenn man
1190 sich nach dem Update der Installation das erste Mal im
1191 Administrationsbereich anmeldet. Findet Lx-Office die Datei
1192 <literal>users/members</literal>, so wird der Migrationsprozess
1195 <para>Der Migrationsprozess ist nahezu vollautomatisch. Alle
1196 Benutzerdaten können übernommen werden. Nach den Benutzerdaten bietet
1197 Lx-Office noch die Möglichkeit an, dass automatisch eine
1198 Benutzergruppe angelegt wird. Dieser Gruppe wird Zugriff auf alle
1199 Funktionen von Lx-Office gewährt. Alle migrierten Benutzern werden
1200 Mitglied in dieser Gruppe. Damit wird das Verhalten von Lx-Office bis
1201 Version 2.4.3 inklusive wiederhergestellt, und die Benutzer können
1202 sich sofort wieder anmelden und mit dem System arbeiten.</para>
1206 <sect1 id="Drucken-mit-Lx-Office">
1207 <title>Drucken mit Lx-Office</title>
1209 <para>Das Drucksystem von Lx-Office benutzt von Haus aus LaTeX Vorlagen.
1210 Um drucken zu können, braucht der Server ein geeignetes LaTeX System. Am
1211 einfachsten ist dazu eine <literal>texlive</literal> Installation. Unter
1212 Debianoiden Betriebssystemen sind das die Pakete:</para>
1214 <para><literal>texlive-latex-base texlive-latex-extra
1215 texlive-fonts-recommended</literal></para>
1217 <para>Diese hinteren beiden enthalten Bibliotheken und Schriftarten die
1218 von den Standardvorlagen verwendet werden.</para>
1220 <para>TODO: rpm Pakete.</para>
1222 <para>In den allermeisten Installationen sollte drucken jetzt schon
1223 funktionieren. Sollte ein Fehler auftreten wirft TeX sehr lange
1224 Fehlerbeschreibungen, der eigentliche Fehler ist immer die erste Zeite
1225 die mit einem Ausrufezeichen anfängt. Häufig auftretende Fehler sind zum
1230 <para>! LaTeX Error: File `eurosym.sty' not found. Die entsprechende
1231 LaTeX-Bibliothek wurde nicht gefunden. Das tritt vor allem bei
1232 Vorlagen aus der Community auf. Installieren Sie die entsprechenden
1237 <para>! Package inputenc Error: Unicode char \u8:æ¡
\9c not set up for
1238 use with LaTeX. Dieser Fehler tritt auf, wenn sie versuchen mit
1239 einer Standardinstallation exotische utf8 Zeichen zu drucken.
1240 TeXLive unterstützt von Haus nur romanische Schriften und muss mit
1241 diversen Tricks dazu gebracht werden andere Zeichen zu akzeptieren.
1242 Adere TeX Systeme wie XeTeX schaffen hier Abhilfe.</para>
1246 <para>Wird garkein Fehler angezeigt sondern nur der Name des Templates,
1247 heißt das normalerweise, dass das LaTeX Binary nicht gefunden wurde.
1248 Prüfen Sie den Namen in der Konfiguration (Standard:
1249 <literal>pdflatex</literal>), und stellen Sie sicher, dass pdflatex
1250 (oder das von Ihnen verwendete System) vom Webserver ausgeführt werden
1254 <sect1 id="OpenDocument-Vorlagen">
1255 <title>OpenDocument-Vorlagen</title>
1257 <para>Lx-Office unterstützt die Verwendung von Vorlagen im
1258 OpenDocument-Format, wie es OpenOffice.org ab Version 2 erzeugt.
1259 Lx-Office kann dabei sowohl neue OpenDocument-Dokumente als auch aus
1260 diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
1261 OpenDocument-Vorlagen zu aktivieren muss in der Datei
1262 <filename>config/lx_office.conf</filename> die Variable
1263 <literal>opendocument</literal> im Abschnitt
1264 <literal>print_templates</literal> auf ‘<literal>1</literal>’ stehen.
1265 Dieses ist die Standardeinstellung.</para>
1267 <para>Weiterhin muss in der Datei
1268 <filename>config/lx_office.conf</filename> die Variable
1269 <literal>dbcharset</literal> im Abschnitt <literal>system</literal> auf
1270 die Zeichenkodierung gesetzt werden, die auch bei der Speicherung der
1271 Daten in der Datenbank verwendet wird. Diese ist in den meisten Fällen
1274 <para>Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
1275 weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
1276 OpenOffice.org benötigt. Soll dieses Feature genutzt werden, so muss
1277 neben OpenOffice.org ab Version 2 auch der “X virtual frame buffer”
1278 (xvfb) installiert werden. Bei Debian ist er im Paket “xvfb” enthalten.
1279 Andere Distributionen enthalten ihn in anderen Paketen.</para>
1281 <para>Nach der Installation müssen in der Datei
1282 <filename>config/lx_config.conf</filename> zwei weitere Variablen
1283 angepasst werden: <literal>openofficeorg_writer</literal> muss den
1284 vollständigen Pfad zur OpenOffice.org Writer-Anwendung enthalten.
1285 <literal>xvfb</literal> muss den Pfad zum “X virtual frame buffer”
1286 enthalten. Beide stehen im Abschnitt
1287 <literal>applications</literal>.</para>
1289 <para>Zusätzlich gibt es zwei verschiedene Arten, wie Lx-Office mit
1290 OpenOffice kommuniziert. Die erste Variante, die benutzt wird, wenn die
1291 Variable <literal>$openofficeorg_daemon</literal> gesetzt ist, startet
1292 ein OpenOffice, das auch nach der Umwandlung des Dokumentes gestartet
1293 bleibt. Bei weiteren Umwandlungen wird dann diese laufende Instanz
1294 benutzt. Der Vorteil ist, dass die Zeit zur Umwandlung deutlich
1295 reduziert wird, weil nicht für jedes Dokument ein OpenOffice gestartet
1296 werden muss. Der Nachteil ist, dass diese Methode Python und die
1297 Python-UNO-Bindings benötigt, die Bestandteil von OpenOffice 2
1300 <para>Ist <literal>$openofficeorg_daemon</literal> nicht gesetzt, so
1301 wird für jedes Dokument OpenOffice neu gestartet und die Konvertierung
1302 mit Hilfe eines Makros durchgeführt. Dieses Makro muss in der
1303 Dokumentenvorlage enthalten sein und
1304 “Standard.Conversion.ConvertSelfToPDF()” heißen. Die Beispielvorlage
1305 ‘<literal>templates/mastertemplates/German/invoice.odt</literal>’
1306 enthält ein solches Makro, das in jeder anderen Dokumentenvorlage
1307 ebenfalls enthalten sein muss.</para>
1309 <para>Als letztes muss herausgefunden werden, welchen Namen
1310 OpenOffice.org Writer dem Verzeichnis mit den Benutzereinstellungen
1311 gibt. Unter Debian ist dies momentan
1312 <literal>~/.openoffice.org2</literal>. Sollte der Name bei Ihrer
1313 OpenOffice.org-Installation anders sein, so muss das Verzeichnis
1314 <literal>users/.openoffice.org2</literal> entsprechend umbenannt werden.
1315 Ist der Name z.B. einfach nur <literal>.openoffice</literal>, so wäre
1316 folgender Befehl auszuführen:</para>
1318 <para><literal>mv users/.openoffice.org2
1319 users/.openoffice</literal></para>
1321 <para>Dieses Verzeichnis, wie auch das komplette
1322 <literal>users</literal>-Verzeichnis, muss vom Webserver beschreibbar
1323 sein. Dieses wurde bereits erledigt (siehe <xref
1324 linkend="Manuelle-Installation-des-Programmpaketes"/>), kann aber erneut
1325 überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.</para>
1328 <sect1 id="config.eur">
1329 <title>Konfiguration zur Einnahmenüberschussrechnung/Bilanzierung: EUR</title>
1331 <sect2 id="config.eur.introduction" xreflabel="Einführung in die Konfiguration zur EUR">
1332 <title>Einführung</title>
1335 Lx-Office besaß bis inklusive Version 2.6.3 einen Konfigurationsparameter namens <varname>eur</varname>, der sich in der
1336 Konfigurationsdatei <filename>config/lx_office.conf</filename> befindet. Somit galt er für alle Mandanten, die in dieser
1337 Installation benutzt wurden.
1341 Mit der nachfolgenden Version wurde der Parameter zum Einen in die Mandantendatenbank verschoben und dabei auch gleich in drei
1342 Einzelparameter aufgeteilt, mit denen sich das Verhalten genauer steuern lässt.
1346 <sect2 id="config.eur.parameters" xreflabel="Konfigurationsparameter für EUR">
1347 <title>Konfigurationsparameter</title>
1350 Es gibt drei Parameter, die die Gewinnermittlungsart, Versteuerungsart und die Warenbuchungsmethode regeln:
1355 <term><varname>profit_determination</varname></term>
1358 Dieser Parameter legt die Berechnungsmethode für die Gewinnermittlung fest. Er enthält entweder <literal>balance</literal> für
1359 Betriebsvermögensvergleich/Bilanzierung oder <literal>income</literal> für die Einnahmen-Überschuss-Rechnung.
1365 <term><varname>accounting_method</varname></term>
1368 Dieser Parameter steuert die Buchungs- und Berechnungsmethoden für die Versteuerungsart. Er enthält entweder
1369 <literal>accrual</literal> für die Soll-Versteuerung oder <literal>cash</literal> für die Ist-Versteuerung.
1375 <term><varname>inventory_system</varname></term>
1378 Dieser Parameter legt die Warenbuchungsmethode fest. Er enthält entweder <literal>perpetual</literal> für die Bestandsmethode
1379 oder <literal>periodic</literal> für die Aufwandsmethode.
1386 Zum Vergleich der Funktionalität bis und nach 2.6.3: <varname>eur</varname> = 1 bedeutete Einnahmen-Überschuss-Rechnung,
1387 Ist-Versteuerung und Aufwandsmethode. <varname>eur</varname> = 0 bedeutete hingegen Bilanzierung, Soll-Versteuerung und
1392 Die Konfiguration "<varname>eur</varname>" unter <varname>[system]</varname> in der <link
1393 linkend="config.config-file">Konfigurationsdatei</link> <filename>config/lx_office.conf</filename> wird nun nicht mehr benötigt und
1394 kann entfernt werden. Dies muss manuell geschehen.
1398 <sect2 id="config.eur.setting-parameters">
1399 <title>Festlegen der Parameter</title>
1402 Beim Anlegen eines neuen Mandanten bzw. einer neuen Datenbank in der Admininstration können diese Optionen nun unabhängig
1403 voneinander eingestellt werden.
1407 Beim Upgrade bestehender Mandanten wird eur ausgelesen und die Variablen werden so gesetzt, daß sich an der Funktionalität nichts
1412 Die aktuelle Konfiguration wird unter Nummernkreise und Standardkonten unter dem neuen Punkt "Einstellungen" angezeigt (read-only).
1413 Eine spätere Änderung ist für einen bestehenden Mandanten nicht mehr möglich. Dies war auch vorher nicht möglich, bzw. vorhandene
1414 Daten wurden so belassen und haben damit die Ergebnisse verfälscht.
1418 <sect2 id="config.eur.inventory-system-perpetual">
1419 <title>Bemerkungen zu Bestandsmethode</title>
1422 Die Bestandsmethode ist eigentlich eine sehr elegante Methode, funktioniert in Lx-Office aber nur unter bestimmten Bedingungen:
1423 Voraussetzung ist, daß auch immer alle Einkaufsrechnungen gepflegt werden, und man beim Jahreswechsel nicht mit einer leeren
1424 Datenbank anfängt, da bei jedem Verkauf anhand der gesamten Rechnungshistorie der Einkaufswert der Ware nach dem FIFO-Prinzip aus
1425 den Einkaufsrechnungen berechnet wird.
1429 Die Bestandsmethode kann vom Prinzip her also nur funktioneren, wenn man mit den Buchungen bei Null anfängt, und man kann auch nicht
1430 im laufenden Betrieb von der Aufwandsmethode zur Bestandsmethode wechseln.
1434 <sect2 id="config.eur.knonw-issues">
1435 <title>Bekannte Probleme</title>
1438 Bei bestimmten Berichten kann man derzeit noch inviduell einstellen, ob man nach Ist- oder Sollversteuerung auswertet, und es werden
1439 im Code Variablen wie $accrual oder $cash gesetzt. Diese Codestellen wurden noch nicht angepasst, sondern nur die, wo bisher
1440 die Konfigurationsvariable <varname>$::lx_office_conf{system}->{eur}</varname> ausgewertet wurde.
1444 Es fehlen Hilfetext beim Neuanlegen eines Mandanten, was die Optionen bewirken, z.B. mit zwei Standardfällen.
1449 <sect1 id="Lx-Office-ERP-verwenden">
1450 <title>Lx-Office ERP verwenden</title>
1452 <para>Nach erfolgreicher Installation ist der Loginbildschirm unter
1453 folgender URL erreichbar:</para>
1456 url="http://localhost/lx-office-erp/login.pl">http://localhost/lx-office-erp/login.pl</ulink></para>
1458 <para>Die Administrationsseite erreichen Sie unter:</para>
1461 url="http://localhost/lx-office-erp/admin.pl">http://localhost/lx-office-erp/admin.pl</ulink></para>
1465 <chapter id="features" xreflabel="Features und Funktionen">
1466 <title>Features und Funktionen</title>
1468 <sect1 id="features.periodic-invoices" xreflabel="Wiedekehrende Rechnungen">
1469 <title>Wiederkehrende Rechnungen</title>
1471 <sect2 id="features.periodic-invoices.introduction" xreflabel="Einführung in wiederkehrende Rechnungen">
1472 <title>Einführung</title>
1475 Wiederkehrende Rechnungen werden als normale Aufträge definiert und konfiguriert, mit allen dazugehörigen Kunden- und
1476 Artikelangaben. Die konfigurierten Aufträge werden später automatisch in Rechnungen umgewandelt, so als ob man den Workflow benutzen
1477 würde, und auch die Auftragsnummer wird übernommen, sodass alle wiederkehrenden Rechnungen, die aus einem Auftrag erstellt wurden,
1478 später leicht wiederzufinden sind.
1483 <sect2 id="features.periodic-invoices.configuration" xreflabel="Konfiguration von wiederkehrenden Rechnungen">
1484 <title>Konfiguration</title>
1487 Um einen Auftrag für wiederkehrende Rechnung zu konfigurieren, findet sich beim Bearbeiten des Auftrags ein neuer Knopf
1488 "Konfigurieren", der ein neues Fenster öffnet, in dem man die nötigen Parameter einstellen kann. Hinter dem Knopf wird außerdem noch
1489 angezeigt, ob der Auftrag als wiederkehrende Rechnung konfiguriert ist oder nicht.
1493 Folgende Parameter kann man konfigurieren:
1501 Bei aktiven Rechnungen wird automatisch eine Rechnung erstellt, wenn die Periodizität erreicht ist (z.B. Anfang eines neuen
1506 Ist ein Auftrag nicht aktiv, so werden für ihn auch keine wiederkehrenden Rechnungen erzeugt. Stellt man nach längerer
1507 nicht-aktiver Zeit einen Auftrag wieder auf aktiv, wird beim nächsten Periodenwechsel für alle Perioden, seit der letzten aktiven
1508 Periode, jeweils eine Rechnung erstellt. Möchte man dies verhindern, muss man vorher das Startdatum neu setzen.
1512 Für gekündigte Aufträge werden nie mehr Rechnungen erstellt. Man kann sich diese Aufträge aber gesondert in den Berichten anzeigen
1519 <term>Periodizität</term>
1522 Ob monatlich, quartalsweise oder jährlich auf neue Rechnungen überprüft werden soll. Für jede Periode seit dem Startdatum wird
1523 überprüft, ob für die Periode (beginnend immer mit dem ersten Tag der Periode) schon eine Rechnung erstellt wurde. Unter Umständen
1524 können bei einem Startdatum in der Vergangenheit gleich mehrere Rechnungen erstellt werden.
1530 <term>Buchen auf</term>
1533 Das Forderungskonto, in der Regel "Forderungen aus Lieferungen und Leistungen". Das Gegenkonto ergibt sich aus den Buchungsgruppen
1534 der betreffenden Waren.
1540 <term>Startdatum</term>
1543 ab welchem Datum auf Rechnungserstellung geprüft werden soll
1549 <term>Enddatum</term>
1552 ab wann keine Rechnungen mehr erstellt werden sollen
1558 <term>Automatische Verlängerung um x Monate</term>
1561 Sollen die wiederkehrenden Rechnungen bei Erreichen des eingetragenen Enddatums weiterhin erstellt werden, so kann man hier die
1562 Anzahl der Monate eingeben, um die das Enddatum automatisch nach hinten geschoben wird.
1568 <term>Drucken</term>
1571 Sind Drucker konfiguriert, so kann man sich die erstellten Rechnungen auch gleich ausdrucken lassen.
1578 Nach Erstellung der Rechnungen kann eine E-Mail mit Informationen zu den erstellten Rechnungen verschickt werden. Konfiguriert wird
1579 dies in der <link linkend="config.config-file.sections-parameters">Konfigurationsdatei</link>
1580 <filename>config/lx_office.conf</filename> im Abschnitt <varname>[periodic_invoices]</varname>.
1584 <sect2 id="features.periodic-invoices.reports">
1585 <title>Auflisten</title>
1588 Unter Verkauf->Berichte->Aufträge finden sich zwei neue Checkboxen, "Wiederkehrende Rechnungen aktiv" und
1589 "Wiederkehrende Rechnungen inaktiv", mit denen man sich einen Überglick über die wiederkehrenden Rechnungen verschaffen
1594 <sect2 id="features.periodic-invoices.task-server">
1595 <title>Erzeugung der eigentlichen Rechnungen</title>
1598 Die zeitliche und periodische Überprüfung, ob eine wiederkehrende Rechnung automatisch erstellt werden soll, geschieht durch den
1599 <link linkend="config.task-server">Taskserver</link>, einen externen Dienst, der automatisch beim Start des Servers gestartet
1604 <sect2 id="features.periodic-invoices.create-for-current-month">
1605 <title>Erste Rechnung für aktuellen Monat erstellen</title>
1608 Will man im laufenden Monat eine monatlich wiederkehrende Rechnung inkl. des laufenden Monats starten, stellt man das Startdatum auf
1609 den Monatsanfang und wartet ein paar Minuten, bis der Taskserver den neu konfigurieren Auftrag erkennt und daraus eine Rechnung
1610 generiert hat. Alternativ setzt man das Startdatum auf den Monatsersten des Folgemonats und erstellt die erste Rechnung direkt
1611 manuell über den Workflow.
1616 <sect1 id="dokumentenvorlagen-und-variablen">
1617 <title>Dokumentenvorlagen und verfügbare Variablen</title>
1619 <sect2 id="dokumentenvorlagen-und-variablen.einführung">
1620 <title>Einführung</title>
1622 <para>Dies ist eine Auflistung der Standard-Dokumentenvorlagen und
1623 aller zur Bearbeitung verfügbaren Variablen. Eine Variable wird in
1624 einer Vorlage durch ihren Inhalt ersetzt, wenn sie in der Form
1625 <function><%variablenname%></function> verwendet wird. Für
1626 LaTeX- und HTML-Vorlagen kann man die Form dieser Tags auch verändern
1628 linkend="dokumentenvorlagen-und-variablen.tag-style"/>).</para>
1630 <para>Früher wurde hier nur über LaTeX gesprochen. Inzwischen
1631 unterstützt Lx-Office aber auch OpenDocument-Vorlagen. Sofern es nicht
1632 ausdrücklich eingeschränkt wird, gilt das im Folgenden gesagte für
1633 alle Vorlagenarten.</para>
1635 <para>Insgesamt sind technisch gesehen eine ganze Menge mehr Variablen
1636 verfügbar als hier aufgelistet werden. Die meisten davon können
1637 allerdings innerhalb einer solchen Vorlage nicht sinnvoll verwendet
1638 werden. Wenn eine Auflistung dieser Variablen gewollt ist, so kann
1639 diese wie folgt erhalten werden:</para>
1643 <para><filename>SL/Form.pm</filename> öffnen und am Anfang die
1644 Zeile "<command>use Data::Dumper;</command>" einfügen.</para>
1648 <para>In <filename>Form.pm</filename> die Funktion
1649 <function>parse_template</function> suchen und hier die Zeile
1650 <command>print(STDERR Dumper($self));</command> einfügen.</para>
1654 <para>Einmal per Browser die gewünschte Vorlage "benutzen", z.B.
1655 ein PDF für eine Rechnung erzeugen.</para>
1659 <para>Im <filename>error.log</filename> Apache steht die Ausgabe
1660 der Variablen <varname>$self</varname> in der Form <varname>'key'
1661 => 'value',</varname>. Alle <varname>key</varname>s sind
1667 <sect2 id="dokumentenvorlagen-und-variablen.variablen-ausgeben">
1668 <title>Variablen ausgeben</title>
1670 <para>Um eine Variable auszugeben, müssen sie einfach nur zwischen die
1671 Tags geschrieben werden, also z.B.
1672 <varname><%variablenname%></varname>.</para>
1674 <para>Optional kann man auch mit Leerzeichen getrennte Flags angeben,
1675 die man aber nur selten brauchen wird. Die Syntax sieht also so aus:
1676 <varname><%variablenname FLAG1 FLAG2%></varname>. Momentan
1677 werden die folgenden Flags unterstützt:</para>
1681 <para><option>NOFORMAT</option> gilt nur für Zahlenwerte und gibt
1682 den Wert ohne Formatierung, also ohne Tausendertrennzeichen mit
1683 mit einem Punkt als Dezimaltrennzeichen aus. Nützlich z.B., wenn
1684 damit in der Vorlage z.B. von LaTeX gerechnet werden soll.</para>
1688 <para><option>NOESCAPE</option> unterdrückt das Escapen von
1689 Sonderzeichen für die Vorlagensprache. Wenn also in einer
1690 Variablen bereits gültiger LaTeX-Code steht und dieser von LaTeX
1691 auch ausgewertet und nicht wortwörtlich angezeigt werden soll, so
1692 ist dieses Flag sinnvoll.</para>
1696 <para>Beispiel:</para>
1698 <programlisting><%quototal NOFORMAT%></programlisting>
1701 <sect2 id="dokumentenvorlagen-und-variablen.verwendung-in-druckbefehlen">
1702 <title>Verwendung in Druckbefehlen</title>
1704 <para>In der Admininstration können Drucker definiert werden. Auch im
1705 dort eingebbaren Druckbefehl können die hier aufgelisteten Variablen
1706 und Kontrollstrukturen verwendet werden. Ihr Inhalt wird dabei nach
1707 den Regeln der gängigen Shells formatiert, sodass Sonderzeichen wie
1708 <function>`...`</function> nicht zu unerwünschtem Verhalten
1711 <para>Dies erlaubt z.B. die Definition eines Faxes als Druckerbefehl,
1712 für das die Telefonnummer eines Ansprechpartners als Teil der
1713 Kommandozeile verwendet wird. Für ein fiktives Kommando könnte das
1714 z.B. wie folgt aussehen:</para>
1716 <programlisting>send_fax --number <%if cp_phone2%><%cp_phone2%><%else%><%cp_phone1%><%end%></programlisting>
1719 <sect2 id="dokumentenvorlagen-und-variablen.tag-style"
1720 xreflabel="Anfang und Ende der Tags verändern">
1721 <title>Anfang und Ende der Tags verändern</title>
1723 <para>Der Standardstil für Tags sieht vor, dass ein Tag mit dem
1724 Kleinerzeichen und einem Prozentzeichen beginnt und mit dem
1725 Prozentzeichen und dem Größerzeichen endet, beispielsweise
1726 <function><%customer%></function>. Da diese Form aber z.B. in
1727 LaTeX zu Problemen führen kann, weil das Prozentzeichen dort
1728 Kommentare einleitet, kann pro HTML- oder LaTeX-Dokumentenvorlage der
1729 Stil umgestellt werden.</para>
1731 <para>Dazu werden in die Datei Zeilen geschrieben, die mit dem für das
1732 Format gültigen Kommentarzeichen anfangen, dann
1733 <function>config:</function> enthalten, die entsprechende Option
1734 setzen und bei HTML-Dokumentenvorlagen mit dem Kommentarendzeichen
1735 enden. Beispiel für LaTeX:</para>
1737 <programlisting>% config: tag-style=($ $)</programlisting>
1739 <para>Dies würde Lx-Office dazu veranlassen, Variablen zu ersetzen,
1740 wenn sie wie folgt aussehen: <function>($customer$)</function>. Das
1741 äquivalente Beispiel für HTML-Dokumentenvorlagen sieht so aus:</para>
1743 <programlisting><!-- config: tag-style=($ $) --></programlisting>
1746 <sect2 id="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">
1747 <title>Zuordnung von den Dateinamen zu den Funktionen</title>
1749 <para>Diese folgende kurze Auflistung zeigt, welche Vorlage bei
1750 welcher Funktion ausgelesen wird. Dabei ist die Dateiendung
1751 "<filename>.ext</filename>" geeignet zu ersetzen:
1752 "<filename>.tex</filename>" für LaTeX-Vorlagen und
1753 "<filename>.odt</filename>" für OpenDocument-Vorlagen.</para>
1757 <term><filename>bin_list.ext</filename></term>
1760 <para>Lagerliste</para>
1765 <term><filename>check.ext</filename></term>
1773 <term><filename>invoice.ext</filename></term>
1776 <para>Rechnung</para>
1781 <term><filename>packing_list.ext</filename></term>
1784 <para>Packliste</para>
1789 <term><filename>pick_list.ext</filename></term>
1792 <para>Sammelliste</para>
1797 <term><filename>purchase_delivery_order.ext</filename></term>
1800 <para>Lieferschein (Einkauf)</para>
1805 <term><filename>purcharse_order.ext</filename></term>
1808 <para>Bestellung an Lieferanten</para>
1813 <term><filename>request_quotation.ext</filename></term>
1816 <para>Anfrage an Lieferanten</para>
1821 <term><filename>sales_delivery_order.ext</filename></term>
1824 <para>Lieferschein (Verkauf)</para>
1829 <term><filename>sales_order.ext</filename></term>
1832 <para>Bestellung</para>
1837 <term><filename>sales_quotation.ext</filename></term>
1840 <para>Angebot an Kunden</para>
1845 <term><filename>zahlungserinnerung.ext</filename></term>
1848 <para>Mahnung (Dateiname im Programm konfigurierbar)</para>
1853 <term><filename>zahlungserinnerung_invoice.ext</filename></term>
1856 <para>Rechnung über Mahngebühren (Dateiname im Programm
1857 konfigurierbar)</para>
1863 <sect2 id="dokumentenvorlagen-und-variablen.dateinamen-erweitert">
1864 <title>Sprache, Drucker und E-Mail</title>
1866 <para>Angeforderte Sprache und Druckerkürzel in den Dateinamen mit
1867 eingearbeitet. So wird aus der Vorlage
1868 <filename>sales_order.ext</filename> bei Sprache
1869 <function>de</function> und Druckerkürzel <function>lpr2</function>
1870 der Vorlagenname <filename>sales_order_de_lpr2.ext</filename>.
1871 Zusätzlich können für E-Mails andere Vorlagen erstellt werden, diese
1872 bekommen dann noch das Kürzel <filename>_email</filename>, der
1873 vollständige Vorlagenname wäre dann
1874 <filename>sales_order_email_de_lpr2.ext</filename>. In allen Fällen
1875 kann eine Standarddatei <filename>default.ext</filename> hinterlegt
1876 werden. Diese wird verwendet, wenn keine der anderen Varianten
1877 gefunden wird.</para>
1879 <para>Die vollständige Suchreihenfolge für einen Verkaufsauftrag mit
1880 der Sprache "de" und dem Drucker "lpr2", der per E-Mail im Format PDF
1881 verschickt wird, ist:</para>
1885 <para><filename>sales_order_email_de_lpr2.tex</filename></para>
1889 <para><filename>sales_order_de_lpr2.tex</filename></para>
1893 <para><filename>sales_order.tex</filename></para>
1897 <para><filename>default.tex</filename></para>
1901 <para>Die kurzen Varianten dieser Vorlagentitel müssen dann entweder
1902 Standardwerte anzeigen, oder die angeforderten Werte selbst auswerten,
1904 linkend="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"/>.</para>
1907 <sect2 id="dokumentenvorlagen-und-variablen.allgemeine-variablen">
1908 <title>Allgemeine Variablen, die in allen Vorlagen vorhanden
1911 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.meta"
1912 xreflabel="Metainformationen zur angeforderten Vorlage">
1913 <title>Metainformationen zur angeforderten Vorlage</title>
1915 <para>Diese Variablen liefern Informationen darüber welche Variante
1916 einer Vorlage der Benutzer angefragt hat. Sie sind nützlich für
1917 Vorlagenautoren, die aus einer zentralen Layoutvorlage die einzelnen
1918 Formulare einbinden möchten.</para>
1922 <term><varname>template_meta.formname</varname></term>
1925 <para>Basisname der Vorlage. Identisch mit der <link
1926 linkend="dokumentenvorlagen-und-variablen.zuordnung-dateinamen">Zurordnung
1927 zu den Dateinamen</link> ohne die Erweiterung. Ein
1928 Verkaufsauftrag enthält hier
1929 <constant>sales_order</constant>.</para>
1934 <term><varname>template_meta.language.description</varname></term>
1937 <para>Beschreibung der verwendeten Sprache</para>
1942 <term><varname>template_meta.language.template_code</varname></term>
1945 <para>Vorlagenürzel der verwendeten Sprache, identisch mit dem
1946 Kürzel das im Dateinamen verwendetet wird.</para>
1951 <term><varname>template_meta.language.output_numberformat</varname></term>
1954 <para>Zahlenformat der verwendeten Sprache in der Form
1955 "<constant>1.000,00</constant>". Experimentell! Nur
1956 interessant für Vorlagen die mit unformatierten Werten
1962 <term><varname>template_meta.language.output_dateformat</varname></term>
1965 <para>Datumsformat der verwendeten Sprache in der Form
1966 "<constant>dd.mm.yyyy</constant>". Experimentell! Nur
1967 interessant für Vorlagen die mit unformatierten Werten
1973 <term><varname>template_meta.format</varname></term>
1976 <para>Das angeforderte Format. Kann im Moment die Werte
1977 <constant>pdf</constant>, <constant>postscript</constant>,
1978 <constant>html</constant>, <constant>opendocument</constant>,
1979 <constant>opendocument_pdf</constant> und
1980 <constant>excel</constant> enthalten.</para>
1985 <term><varname>template_meta.extension</varname></term>
1988 <para>Dateierweiterung, wie im Dateinamen. Wird aus
1989 <constant>format</constant> entschieden.</para>
1994 <term><varname>template_meta.media</varname></term>
1997 <para>Ausgabemedium. Kann zur Zeit die Werte
1998 <constant>screen</constant> für Bildschirm,
1999 <constant>email</constant> für E-Mmail (triggert das
2000 <constant>_email</constant> Kürzel im Dateinamen),
2001 <constant>printer</constant> für Drucker, und
2002 <constant>queue</constant> für Warteschlange enthalten.</para>
2007 <term><varname>template_meta.printer.description</varname></term>
2010 <para>Beschreibung des ausgewählten Druckers</para>
2015 <term><varname>template_meta.printer.template_code</varname></term>
2018 <para>Vorlagenürzel des ausgewählten Druckers, identisch mit
2019 dem Kürzel das im Dateinamen verwendetet wird.</para>
2025 <sect3 id="dokumentenvorlagen-und-variablen.allgemeine-variablen.kunden-lieferanten">
2026 <title>Stammdaten von Kunden und Lieferanten</title>
2030 <term><varname>account_number</varname></term>
2033 <para>Kontonummer</para>
2038 <term><varname>bank</varname></term>
2041 <para>Name der Bank</para>
2046 <term><varname>bank_code</varname></term>
2049 <para>Bankleitzahl</para>
2054 <term><varname>bic</varname></term>
2057 <para>Bank-Identifikations-Code (Bank Identifier Code,
2063 <term><varname>business</varname></term>
2066 <para>Kunden-/Lieferantentyp</para>
2071 <term><varname>city</varname></term>
2079 <term><varname>contact</varname></term>
2082 <para>Kontakt</para>
2087 <term><varname>country</varname></term>
2095 <term><varname>cp_email</varname></term>
2098 <para>Email des Ansprechpartners</para>
2103 <term><varname>cp_givenname</varname></term>
2106 <para>Vorname des Ansprechpartners</para>
2111 <term><varname>cp_greeting</varname></term>
2114 <para>Anrede des Ansprechpartners</para>
2119 <term><varname>cp_name</varname></term>
2122 <para>Name des Ansprechpartners</para>
2127 <term><varname>cp_phone1</varname></term>
2130 <para>Telefonnummer 1 des Ansprechpartners</para>
2135 <term><varname>cp_phone2</varname></term>
2138 <para>Telefonnummer 2 des Ansprechpartners</para>
2143 <term><varname>cp_title</varname></term>
2146 <para>Titel des Ansprechpartners</para>
2151 <term><varname>creditlimit</varname></term>
2154 <para>Kreditlimit</para>
2159 <term><varname>customeremail</varname></term>
2162 <para>Email des Kunden; nur für Kunden</para>
2167 <term><varname>customerfax</varname></term>
2170 <para>Faxnummer des Kunden; nur für Kunden</para>
2175 <term><varname>customernotes</varname></term>
2178 <para>Bemerkungen beim Kunden; nur für Kunden</para>
2183 <term><varname>customernumber</varname></term>
2186 <para>Kundennummer; nur für Kunden</para>
2191 <term><varname>customerphone</varname></term>
2194 <para>Telefonnummer des Kunden; nur für Kunden</para>
2199 <term><varname>discount</varname></term>
2207 <term><varname>email</varname></term>
2210 <para>Emailadresse</para>
2215 <term><varname>fax</varname></term>
2218 <para>Faxnummer</para>
2223 <term><varname>homepage</varname></term>
2226 <para>Homepage</para>
2231 <term><varname>iban</varname></term>
2234 <para>Internationale Kontonummer (International Bank Account
2235 Number, IBAN)</para>
2240 <term><varname>language</varname></term>
2243 <para>Sprache</para>
2248 <term><varname>name</varname></term>
2251 <para>Firmenname</para>
2256 <term><varname>payment_description</varname></term>
2259 <para>Name der Zahlart</para>
2264 <term><varname>payment_terms</varname></term>
2267 <para>Zahlungskonditionen</para>
2272 <term><varname>phone</varname></term>
2275 <para>Telefonnummer</para>
2280 <term><varname>shiptocity</varname></term>
2283 <para>Stadt (Lieferadresse) <link
2284 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2289 <term><varname>shiptocontact</varname></term>
2292 <para>Kontakt (Lieferadresse) <link
2293 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2298 <term><varname>shiptocountry</varname></term>
2301 <para>Land (Lieferadresse) <link
2302 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2307 <term><varname>shiptodepartment1</varname></term>
2310 <para>Abteilung 1 (Lieferadresse) <link
2311 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2316 <term><varname>shiptodepartment2</varname></term>
2319 <para>Abteilung 2 (Lieferadresse) <link
2320 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2325 <term><varname>shiptoemail</varname></term>
2328 <para>Email (Lieferadresse) <link
2329 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2334 <term><varname>shiptofax</varname></term>
2337 <para>Fax (Lieferadresse) <link
2338 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2343 <term><varname>shiptoname</varname></term>
2346 <para>Firmenname (Lieferadresse) <link
2347 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2352 <term><varname>shiptophone</varname></term>
2355 <para>Telefonnummer (Lieferadresse) <link
2356 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2361 <term><varname>shiptostreet</varname></term>
2364 <para>Straße und Hausnummer (Lieferadresse) <link
2365 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2370 <term><varname>shiptozipcode</varname></term>
2373 <para>Postleitzahl (Lieferadresse) <link
2374 linkend="dokumentenvorlagen-und-variablen.anmerkung-shipto">*</link></para>
2379 <term><varname>street</varname></term>
2382 <para>Straße und Hausnummer</para>
2387 <term><varname>taxnumber</varname></term>
2390 <para>Steuernummer</para>
2395 <term><varname>ustid</varname></term>
2398 <para>Umsatzsteuer-Identifikationsnummer</para>
2403 <term><varname>vendoremail</varname></term>
2406 <para>Email des Lieferanten; nur für Lieferanten</para>
2411 <term><varname>vendorfax</varname></term>
2414 <para>Faxnummer des Lieferanten; nur für Lieferanten</para>
2419 <term><varname>vendornotes</varname></term>
2422 <para>Bemerkungen beim Lieferanten; nur für Lieferanten</para>
2427 <term><varname>vendornumber</varname></term>
2430 <para>Lieferantennummer; nur für Lieferanten</para>
2435 <term><varname>vendorphone</varname></term>
2438 <para>Telefonnummer des Lieferanten; nur für
2444 <term><varname>zipcode</varname></term>
2447 <para>Postleitzahl</para>
2452 <note id="dokumentenvorlagen-und-variablen.anmerkung-shipto">
2453 <para>Anmerkung: Sind die <varname>shipto*</varname>-Felder in den
2454 Stammdaten nicht eingetragen, so haben die Variablen
2455 <varname>shipto*</varname> den gleichen Wert wie die die
2456 entsprechenden Variablen der Lieferdaten. Das bedeutet, dass sich
2457 einige <varname>shipto*</varname>-Variablen so nicht in den
2458 Stammdaten wiederfinden sondern schlicht Kopien der
2459 Lieferdatenvariablen sind (z.B.
2460 <varname>shiptocontact</varname>).</para>
2464 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-bearbeiter">
2465 <title>Informationen über den Bearbeiter</title>
2469 <term><varname>employee_address</varname></term>
2472 <para>Adressfeld</para>
2477 <term><varname>employee_businessnumber</varname></term>
2480 <para>Firmennummer</para>
2485 <term><varname>employee_company</varname></term>
2488 <para>Firmenname</para>
2493 <term><varname>employee_co_ustid</varname></term>
2496 <para>Usatzsteuer-Identifikationsnummer</para>
2501 <term><varname>employee_duns</varname></term>
2504 <para>DUNS-Nummer</para>
2509 <term><varname>employee_email</varname></term>
2517 <term><varname>employee_fax</varname></term>
2525 <term><varname>employee_name</varname></term>
2528 <para>voller Name</para>
2533 <term><varname>employee_signature</varname></term>
2536 <para>Signatur</para>
2541 <term><varname>employee_taxnumber</varname></term>
2544 <para>Steuernummer</para>
2549 <term><varname>employee_tel</varname></term>
2552 <para>Telefonnummer</para>
2558 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-verkaeufer">
2559 <title>Informationen über den Bearbeiter</title>
2563 <term><varname>salesman_address</varname></term>
2566 <para>Adressfeld</para>
2571 <term><varname>salesman_businessnumber</varname></term>
2574 <para>Firmennummer</para>
2579 <term><varname>salesman_company</varname></term>
2582 <para>Firmenname</para>
2587 <term><varname>salesman_co_ustid</varname></term>
2590 <para>Usatzsteuer-Identifikationsnummer</para>
2595 <term><varname>salesman_duns</varname></term>
2598 <para>DUNS-Nummer</para>
2603 <term><varname>salesman_email</varname></term>
2611 <term><varname>salesman_fax</varname></term>
2619 <term><varname>salesman_name</varname></term>
2622 <para>voller Name</para>
2627 <term><varname>salesman_signature</varname></term>
2630 <para>Signatur</para>
2635 <term><varname>salesman_taxnumber</varname></term>
2638 <para>Steuernummer</para>
2643 <term><varname>salesman_tel</varname></term>
2646 <para>Telefonnummer</para>
2652 <sect3 id="dokumentenvorlagen-und-variablen.allgemein-steuern">
2653 <title>Variablen für die einzelnen Steuern</title>
2657 <term><varname>tax</varname></term>
2665 <term><varname>taxbase</varname></term>
2668 <para>zu versteuernder Betrag</para>
2673 <term><varname>taxdescription</varname></term>
2676 <para>Name der Steuer</para>
2681 <term><varname>taxrate</varname></term>
2684 <para>Steuersatz</para>
2691 <sect2 id="dokumentenvorlagen-und-variablen.invoice">
2692 <title>Variablen in Rechnungen</title>
2694 <sect3 id="dokumentenvorlagen-und-variablen.invoice-allgemein">
2695 <title>Allgemeine Variablen</title>
2699 <term><varname>creditremaining</varname></term>
2702 <para>Verbleibender Kredit</para>
2707 <term><varname>currency</varname></term>
2710 <para>Währung</para>
2715 <term><varname>cusordnumber</varname></term>
2718 <para>Bestellnummer beim Kunden</para>
2723 <term><varname>deliverydate</varname></term>
2726 <para>Lieferdatum</para>
2731 <term><varname>duedate</varname></term>
2734 <para>Fälligkeitsdatum</para>
2739 <term><varname>globalprojectnumber</varname></term>
2742 <para>Projektnummer des ganzen Beleges</para>
2747 <term><varname>globalprojectdescription</varname></term>
2750 <para>Projekbeschreibung des ganzen Beleges</para>
2755 <term><varname>intnotes</varname></term>
2758 <para>Interne Bemerkungen</para>
2763 <term><varname>invdate</varname></term>
2766 <para>Rechnungsdatum</para>
2771 <term><varname>invnumber</varname></term>
2774 <para>Rechnungsnummer</para>
2779 <term><varname>invtotal</varname></term>
2782 <para>gesamter Rechnungsbetrag</para>
2787 <term><varname>notes</varname></term>
2790 <para>Bemerkungen der Rechnung</para>
2795 <term><varname>orddate</varname></term>
2798 <para>Auftragsdatum</para>
2803 <term><varname>ordnumber</varname></term>
2806 <para>Auftragsnummer, wenn die Rechnung aus einem Auftrag
2807 erstellt wurde</para>
2812 <term><varname>payment_description</varname></term>
2815 <para>Name der Zahlart</para>
2820 <term><varname>payment_terms</varname></term>
2823 <para>Zahlungskonditionen</para>
2828 <term><varname>quodate</varname></term>
2831 <para>Angebotsdatum</para>
2836 <term><varname>quonumber</varname></term>
2839 <para>Angebotsnummer</para>
2844 <term><varname>shippingpoint</varname></term>
2847 <para>Versandort</para>
2852 <term><varname>shipvia</varname></term>
2855 <para>Transportmittel</para>
2860 <term><varname>subtotal</varname></term>
2863 <para>Zwischensumme aller Posten ohne Steuern</para>
2868 <term><varname>total</varname></term>
2871 <para>Restsumme der Rechnung (Summe abzüglich bereits
2872 bezahlter Posten)</para>
2877 <term><varname>transaction_description</varname></term>
2880 <para>Vorgangsbezeichnung</para>
2885 <term><varname>transdate</varname></term>
2888 <para>Auftragsdatum wenn die Rechnung aus einem Auftrag
2889 erstellt wurde</para>
2895 <sect3 id="dokumentenvorlagen-und-variablen.invoice-posten">
2896 <title>Variablen für jeden Posten auf der Rechnung</title>
2900 <term><varname>bin</varname></term>
2903 <para>Stellage</para>
2908 <term><varname>description</varname></term>
2911 <para>Artikelbeschreibung</para>
2916 <term><varname>discount</varname></term>
2919 <para>Rabatt als Betrag</para>
2924 <term><varname>discount_sub</varname></term>
2927 <para>Zwischensumme mit Rabatt</para>
2932 <term><varname>drawing</varname></term>
2935 <para>Zeichnung</para>
2940 <term><varname>ean</varname></term>
2943 <para>EAN-Code</para>
2948 <term><varname>image</varname></term>
2956 <term><varname>linetotal</varname></term>
2959 <para>Zeilensumme (Anzahl * Einzelpreis)</para>
2964 <term><varname>longdescription</varname></term>
2967 <para>Langtext</para>
2972 <term><varname>microfiche</varname></term>
2975 <para>Mikrofilm</para>
2980 <term><varname>netprice</varname></term>
2983 <para>Nettopreis</para>
2988 <term><varname>nodiscount_linetotal</varname></term>
2991 <para>Zeilensumme ohne Rabatt</para>
2996 <term><varname>nodiscount_sub</varname></term>
2999 <para>Zwischensumme ohne Rabatt</para>
3004 <term><varname>number</varname></term>
3007 <para>Artikelnummer</para>
3012 <term><varname>ordnumber_oe</varname></term>
3015 <para>Auftragsnummer des Originalauftrags, wenn die Rechnung
3016 aus einem Sammelauftrag erstellt wurde</para>
3021 <term><varname>p_discount</varname></term>
3024 <para>Rabatt in Prozent</para>
3029 <term><varname>partnotes</varname></term>
3032 <para>Die beim Artikel gespeicherten Bemerkungen</para>
3037 <term><varname>partsgroup</varname></term>
3040 <para>Warengruppe</para>
3045 <term><varname>price_factor</varname></term>
3048 <para>Der Preisfaktor als Zahl, sofern einer eingestellt
3054 <term><varname>price_factor_name</varname></term>
3057 <para>Der Name des Preisfaktors, sofern einer eingestellt
3063 <term><varname>projectnumber</varname></term>
3066 <para>Projektnummer</para>
3071 <term><varname>projectdescription</varname></term>
3074 <para>Projektbeschreibung</para>
3079 <term><varname>qty</varname></term>
3087 <term><varname>reqdate</varname></term>
3090 <para>Lieferdatum</para>
3095 <term><varname>runningnumber</varname></term>
3098 <para>Position auf der Rechnung (1, 2, 3...)</para>
3103 <term><varname>sellprice</varname></term>
3106 <para>Verkaufspreis</para>
3111 <term><varname>serialnumber</varname></term>
3114 <para>Seriennummer</para>
3119 <term><varname>tax_rate</varname></term>
3122 <para>Steuersatz</para>
3127 <term><varname>transdate_oe</varname></term>
3130 <para>Auftragsdatum des Originalauftrags, wenn die Rechnung
3131 aus einem Sammelauftrag erstellt wurde</para>
3136 <term><varname>unit</varname></term>
3139 <para>Einheit</para>
3144 <term><varname>weight</varname></term>
3147 <para>Gewicht</para>
3152 <para>Für jeden Posten gibt es ein Unterarray mit den Informationen
3153 über Lieferanten und Lieferantenartikelnummer. Diese müssen mit
3154 einer <function>foreach</function>-Schleife ausgegeben werden, da
3155 für jeden Artikel mehrere Lieferanteninformationen hinterlegt sein
3156 können. Die Variablen dafür lauten:</para>
3160 <term><varname>make</varname></term>
3163 <para>Lieferant</para>
3168 <term><varname>model</varname></term>
3171 <para>Lieferantenartikelnummer</para>
3177 <sect3 id="dokumentenvorlagen-und-variablen.invoice-zahlungen">
3178 <title>Variablen für die einzelnen Zahlungseingänge</title>
3182 <term><varname>payment</varname></term>
3190 <term><varname>paymentaccount</varname></term>
3198 <term><varname>paymentdate</varname></term>
3206 <term><varname>paymentmemo</varname></term>
3214 <term><varname>paymentsource</varname></term>
3223 <sect3 id="dokumentenvorlagen-und-variablen.benutzerdefinierte-variablen-vc">
3224 <title>Benutzerdefinierte Kunden- und Lieferantenvariablen</title>
3226 <para>Die vom Benutzer definierten Variablen für Kunden und
3227 Lieferanten stehen beim Ausdruck von Einkaufs- und Verkaufsbelegen
3228 ebenfalls zur Verfügung. Ihre Namen setzen sich aus dem Präfix
3229 <varname>vc_cvar_</varname> und dem vom Benutzer festgelegten
3230 Variablennamen zusammen.</para>
3232 <para>Beispiel: Der Benutzer hat eine Variable namens
3233 <varname>number_of_employees</varname> definiert, die die Anzahl der
3234 Mitarbeiter des Unternehmens enthält. Diese Variable steht dann
3235 unter dem Namen <varname>vc_cvar_number_of_employees</varname> zur
3240 <sect2 id="dokumentenvorlagen-und-variablen.dunning">
3241 <title>Variablen in Mahnungen und Rechnungen über Mahngebühren</title>
3243 <sect3 id="dokumentenvorlagen-und-variablen.dunning-vorlagennamen">
3244 <title>Namen der Vorlagen</title>
3246 <para>Die Namen der Vorlagen werden im System-Menü vom Benutzer
3247 eingegeben. Wird für ein Mahnlevel die Option zur automatischen
3248 Erstellung einer Rechnung über die Mahngebühren und Zinsen
3249 aktiviert, so wird der Name der Vorlage für diese Rechnung aus dem
3250 Vorlagenname für diese Mahnstufe mit dem Zusatz
3251 <constant>_invoice</constant> gebildet. Weiterhin werden die Kürzel
3252 für die ausgewählte Sprache und den ausgewählten Drucker
3256 <sect3 id="dokumentenvorlagen-und-variablen.dunning-allgemein">
3257 <title>Allgemeine Variablen in Mahnungen</title>
3259 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3260 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3261 Kunden stehen als Variablen <varname>name</varname>,
3262 <varname>street</varname>, <varname>zipcode</varname>,
3263 <varname>city</varname>, <varname>country</varname>,
3264 <varname>department_1</varname>, <varname>department_2</varname>,
3265 und <varname>email</varname> zur Verfügung.</para>
3267 <para>Weitere Variablen beinhalten:</para>
3271 <term><varname>dunning_date</varname></term>
3274 <para>Datum der Mahnung</para>
3279 <term><varname>dunning_duedate</varname></term>
3282 <para>Fälligkeitsdatum für diese Mahhnung</para>
3287 <term><varname>dunning_id</varname></term>
3290 <para>Mahnungsnummer</para>
3295 <term><varname>fee</varname></term>
3298 <para>Kummulative Mahngebühren</para>
3303 <term><varname>interest_rate</varname></term>
3306 <para>Zinssatz per anno in Prozent</para>
3311 <term><varname>total_amount</varname></term>
3314 <para>Gesamter noch zu zahlender Betrag als
3315 <function>fee</function> + <function>total_interest</function>
3316 + <function>total_open_amount</function></para>
3321 <term><varname>total_interest</varname></term>
3324 <para>Zinsen per anno über alle Rechnungen</para>
3329 <term><varname>total_open_amount</varname></term>
3332 <para>Summe über alle offene Beträge der Rechnungen</para>
3338 <sect3 id="dokumentenvorlagen-und-variablen.dunning-details">
3339 <title>Variablen für jede gemahnte Rechnung in einer Mahnung</title>
3343 <term><varname>dn_amount</varname></term>
3346 <para>Rechnungssumme (brutto)</para>
3351 <term><varname>dn_duedate</varname></term>
3354 <para>Originales Fälligkeitsdatum der Rechnung</para>
3359 <term><varname>dn_dunning_date</varname></term>
3362 <para>Datum der Mahnung</para>
3367 <term><varname>dn_dunning_duedate</varname></term>
3370 <para>Fälligkeitsdatum der Mahnung</para>
3375 <term><varname>dn_fee</varname></term>
3378 <para>Kummulative Mahngebühr</para>
3383 <term><varname>dn_interest</varname></term>
3386 <para>Zinsen per anno für diese Rechnung</para>
3391 <term><varname>dn_invnumber</varname></term>
3394 <para>Rechnungsnummer</para>
3399 <term><varname>dn_linetotal</varname></term>
3402 <para>Noch zu zahlender Betrag (ergibt sich aus
3403 <varname>dn_open_amount</varname> + <varname>dn_fee</varname>
3404 + <varname>dn_interest</varname>)</para>
3409 <term><varname>dn_netamount</varname></term>
3412 <para>Rechnungssumme (netto)</para>
3417 <term><varname>dn_open_amount</varname></term>
3420 <para>Offener Rechnungsbetrag</para>
3425 <term><varname>dn_ordnumber</varname></term>
3428 <para>Bestellnummer</para>
3433 <term><varname>dn_transdate</varname></term>
3436 <para>Rechnungsdatum</para>
3441 <term><varname>dn_curr</varname></term>
3444 <para>Währung, in der die Rechnung erstellt wurde. (Die
3445 Rechnungsbeträge sind aber immer in der Hauptwährung)</para>
3451 <sect3 id="dokumentenvorlagen-und-variablen.dunning-invoice">
3452 <title>Variablen in automatisch erzeugten Rechnungen über
3453 Mahngebühren</title>
3455 <para>Die Variablen des Verkäufers stehen wie gewohnt als
3456 <varname>employee_...</varname> zur Verfügung. Die Adressdaten des
3457 Kunden stehen als Variablen <varname>name</varname>,
3458 <varname>street</varname>, <varname>zipcode</varname>,
3459 <varname>city</varname>, <varname>country</varname>,
3460 <varname>department_1</varname>, <varname>department_2</varname>,
3461 und <varname>email</varname> zur Verfügung.</para>
3463 <para>Weitere Variablen beinhalten:</para>
3467 <term><varname>duedate</varname></term>
3470 <para>Fälligkeitsdatum der Rechnung</para>
3475 <term><varname>dunning_id</varname></term>
3478 <para>Mahnungsnummer</para>
3483 <term><varname>fee</varname></term>
3486 <para>Mahngebühren</para>
3491 <term><varname>interest</varname></term>
3499 <term><varname>invamount</varname></term>
3502 <para>Rechnungssumme (ergibt sich aus <varname>fee</varname> +
3503 <varname>interest</varname>)</para>
3508 <term><varname>invdate</varname></term>
3511 <para>Rechnungsdatum</para>
3516 <term><varname>invnumber</varname></term>
3519 <para>Rechnungsnummer</para>
3526 <sect2 id="dokumentenvorlagen-und-variablen.andere-vorlagen">
3527 <title>Variablen in anderen Vorlagen</title>
3530 <title>Einführung</title>
3532 <para>Die Variablen in anderen Vorlagen sind ähnlich wie in der
3533 Rechnung. Allerdings heißen die Variablen, die mit
3534 <varname>inv</varname> beginnen, jetzt anders. Bei den Angeboten
3535 fangen sie mit <varname>quo</varname> für "quotation" an:
3536 <varname>quodate</varname> für Angebotsdatum etc. Bei Bestellungen
3537 wiederum fangen sie mit <varname>ord</varname> für "order" an:
3538 <varname>ordnumber</varname> für Bestellnummer etc.</para>
3540 <para>Manche Variablen sind in anderen Vorlagen hingegen gar nicht
3541 vorhanden wie z.B. die für bereits verbuchte Zahlungseingänge. Dies
3542 sind Variablen, die vom Geschäftsablauf her in der entsprechenden
3543 Vorlage keine Bedeutung haben oder noch nicht belegt sein
3546 <para>Im Folgenden werden nur wichtige Unterschiede zu den Variablen
3547 in Rechnungen aufgeführt.</para>
3550 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-quotations">
3551 <title>Angebote und Preisanfragen</title>
3555 <term><varname>quonumber</varname></term>
3558 <para>Angebots- bzw. Anfragenummer</para>
3563 <term><varname>reqdate</varname></term>
3566 <para>Gültigkeitsdatum (bei Angeboten) bzw. Lieferdatum (bei
3567 Preisanfragen)</para>
3572 <term><varname>transdate</varname></term>
3575 <para>Angebots- bzw. Anfragedatum</para>
3581 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-orders">
3582 <title>Auftragsbestätigungen und Lieferantenaufträge</title>
3586 <term><varname>ordnumber</varname></term>
3589 <para>Auftragsnummer</para>
3594 <term><varname>reqdate</varname></term>
3597 <para>Lieferdatum</para>
3602 <term><varname>transdate</varname></term>
3605 <para>Auftragsdatum</para>
3611 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-delivery-orders">
3612 <title>Lieferscheine (Verkauf und Einkauf)</title>
3616 <term><varname>cusordnumber</varname></term>
3619 <para>Bestellnummer des Kunden (im Verkauf) bzw. Bestellnummer
3620 des Lieferanten (im Einkauf)</para>
3625 <term><varname>donumber</varname></term>
3628 <para>Lieferscheinnummer</para>
3633 <term><varname>transdate</varname></term>
3636 <para>Lieferscheindatum</para>
3641 <para>Für jede Position eines Lieferscheines gibt es ein Unterarray
3642 mit den Informationen darüber, von welchem Lager und Lagerplatz aus
3643 die Waren verschickt wurden (Verkaufslieferscheine) bzw. auf welchen
3644 Lagerplatz sie eingelagert wurden. Diese müssen mittels einer
3645 <function>foreach</function>-Schleife ausgegeben werden. Diese
3646 Variablen sind:</para>
3650 <term><varname>si_bin</varname></term>
3653 <para>Lagerplatz</para>
3658 <term><varname>si_chargenumber</varname></term>
3661 <para>Chargennummer</para>
3666 <term><varname>si_bestbefore</varname></term>
3669 <para>Mindesthaltbarkeit</para>
3674 <term><varname>si_number</varname></term>
3677 <para>Artikelnummer</para>
3682 <term><varname>si_qty</varname></term>
3685 <para>Anzahl bzw. Menge</para>
3690 <term><varname>si_runningnumber</varname></term>
3693 <para>Positionsnummer (1, 2, 3 etc)</para>
3698 <term><varname>si_unit</varname></term>
3701 <para>Einheit</para>
3706 <term><varname>si_warehouse</varname></term>
3715 <sect3 id="dokumentenvorlagen-und-variablen.andere-vorlagen-statement">
3716 <title>Variablen für Sammelrechnung</title>
3720 <term><varname>c0total</varname></term>
3723 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit < 30
3729 <term><varname>c30total</varname></term>
3732 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 30
3733 und < 60 Tage</para>
3738 <term><varname>c60total</varname></term>
3741 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 60
3742 und < 90 Tage</para>
3747 <term><varname>c90total</varname></term>
3750 <para>Gesamtbetrag aller Rechnungen mit Fälligkeit >= 90
3756 <term><varname>total</varname></term>
3759 <para>Gesamtbetrag aller Rechnungen</para>
3764 <para>Variablen für jede Rechnungsposition in Sammelrechnung:</para>
3768 <term><varname>invnumber</varname></term>
3771 <para>Rechnungsnummer</para>
3776 <term><varname>invdate</varname></term>
3779 <para>Rechnungsdatum</para>
3784 <term><varname>duedate</varname></term>
3787 <para>Fälligkeitsdatum</para>
3792 <term><varname>amount</varname></term>
3795 <para>Summe der Rechnung</para>
3800 <term><varname>open</varname></term>
3803 <para>Noch offener Betrag der Rechnung</para>
3808 <term><varname>c0</varname></term>
3811 <para>Noch offener Rechnungsbetrag mit Fälligkeit < 30
3817 <term><varname>c30</varname></term>
3820 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 30 und
3826 <term><varname>c60</varname></term>
3829 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 60 und
3835 <term><varname>c90</varname></term>
3838 <para>Noch offener Rechnungsbetrag mit Fälligkeit >= 90
3846 <sect2 id="dokumentenvorlagen-und-variablen.bloecke">
3847 <title>Blöcke, bedingte Anweisungen und Schleifen</title>
3849 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.einfuehrung">
3850 <title>Einfürhung</title>
3852 <para>Der Parser kennt neben den Variablen einige weitere
3853 Konstrukte, die gesondert behandelt werden. Diese sind wie
3854 Variablennamen in spezieller Weise markiert:
3855 <command><%anweisung%> ... <%end%></command></para>
3857 <para>Anmerkung zum <command><%end%></command>: Der besseren
3858 Verständlichkeit halber kann man nach dem <command>end</command>
3859 noch beliebig weitere Wörter schreiben, um so zu markieren, welche
3860 Anweisung (z.B. <command>if</command> oder
3861 <command>foreach</command>) damit abgeschlossen wird.</para>
3863 <para>Beispiel: Lautet der Beginn eines Blockes z.B.
3864 <command><%if type == "sales_quotation"%></command>, so könnte
3865 er mit <command><%end%></command> genauso abgeschlossen werden
3866 wie mit <command><%end if%></command> oder auch
3867 <command><%end type == "sales_quotation"%></command>.</para>
3870 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.if">
3871 <title>Der if-Block</title>
3873 <programlisting><%if variablenname%>
3875 <%end%></programlisting>
3877 <para>Eine normale "if-then"-Bedingung. Die Zeilen zwischen dem "if"
3878 und dem "end" werden nur ausgegeben, wenn die Variable
3879 <varname>variablenname</varname> gesetzt und ungleich 0 ist.</para>
3881 <para>Die Bedingung kann auch negiert werden, indem das Wort
3882 <function>not</function> nach dem <filename>if</filename> verwendet
3883 wird. Beispiel:</para>
3885 <programlisting><%if not cp_greeting%>
3887 <%end%></programlisting>
3889 <para>Zusätzlich zu dem einfachen Test, ob eine Variable gesetzt ist
3890 oder nicht, bietet dieser Block auch die Möglichkeit, den Inhalt
3891 einer Variablen mit einer festen Zeichenkette oder einer anderen
3892 Variablen zu vergleichen. Ob der Vergleich mit einer Zeichenkette
3893 oder einer anderen Variablen vorgenommen wird, hängt davon ab, ob
3894 die rechte Seite des Vergleichsoperators in Anführungszeichen
3895 gesetzt wird (Vergleich mit Zeichenkette) oder nicht (Vergleich mit
3896 anderer Variablen). Zwei Beispiele, die beide Vergleiche
3899 <programlisting><%if var1 == "Wert"%></programlisting>
3901 <para>Testet die Variable <varname>var1</varname> auf
3902 übereinstimmung mit der Zeichenkette <constant>Wert</constant>.
3903 Mittels <function>!=</function> anstelle von <function>==</function>
3904 würde auf Ungleichheit getestet.</para>
3906 <programlisting>%if var1 == var2%></programlisting>
3908 <para>Testet die Variable <varname>var1</varname> auf
3909 übereinstimmung mit der Variablen <varname>var2</varname>. Mittel
3910 <function>!=</function> anstelle von <function>==</function> würde
3911 auf Ungleichheit getestet.</para>
3913 <para>Erfahrere Benutzer können neben der Tests auf (Un-)Gleichheit
3914 auch Tests auf übereinstimmung mit regulären Ausdrücken ohne
3915 Berücksichtung der Groß- und Kleinschreibung durchführen. Dazu dient
3916 dieselbe Syntax wie oben nur mit <function>=~</function> und
3917 <function>!~</function> als Vergleichsoperatoren.</para>
3919 <para>Beispiel für einen Test, ob die Variable
3920 <varname>intnotes</varname> (interne Bemerkungen) das Wort
3921 <constant>schwierig</constant> enthält:</para>
3923 <programlisting><%if intnotes =~ "schwierig"%></programlisting>
3926 <sect3 id="dokumentenvorlagen-und-variablen.bloecke.foreach">
3927 <title>Der foreach-Block</title>
3929 <programlisting><%foreach variablenname%>
3931 <%end%></programlisting>
3933 <para>Fügt die Zeilen zwischen den beiden Anweisungen so oft ein,
3934 wie das Perl-Array der Variablen <varname>variablenname</varname>
3935 Elemente enthät. Dieses Konstrukt wird zur Ausgabe der einzelnen
3936 Posten einer Rechnung / eines Angebots sowie zur Ausgabe der Steuern
3937 benutzt. In jedem Durchlauf werden die <link
3938 linkend="dokumentenvorlagen-und-variablen.invoice-posten">zeilenbezogenen
3939 Variablen</link> jeweils auf den Wert für die aktuelle Position
3942 <para>Die Syntax sieht normalerweise wie folgt aus:</para>
3944 <programlisting><%foreach number%>
3945 Position: <%runningnumber%>
3946 Anzahl: <%qty%>
3947 Artikelnummer: <%number%>
3948 Beschreibung: <%description%>
3950 <%end%></programlisting>
3952 <para>Besonderheit in OpenDocument-Vorlagen: Tritt ein
3953 <function><%foreach%></function>-Block innerhalb einer
3954 Tabellenzelle auf, so wird die komplette Tabellenzeile so oft
3955 wiederholt wie notwendig. Tritt er außerhalb auf, so wird nur der
3956 Inhalt zwischen <function><%foreach%></function> und
3957 <function><%end%></function> wiederholt, nicht aber die
3958 komplette Zeile, in der er steht.</para>
3962 <sect2 id="dokumentenvorlagen-und-variablen.markup">
3963 <title>Markup-Code zur Textformatierung innerhalb von
3966 <para>Wenn der Benutzer innhalb von Formularen in Lx-Office Text
3967 anders formatiert haben möchte, so ist dies begrenzt möglich.
3968 Lx-Office unterstützt die Textformatierung mit HTML-ähnlichen Tags.
3969 Der Benutzer kann z.B. bei der Artikelbeschreibung auf einer Rechnung
3970 Teile des Texts zwischen Start- und Endtags setzen. Dieser Teil wird
3971 dann automatisch in Anweisungen für das ausgewählte Vorlagenformat
3972 (HTML oder PDF über LaTeX) umgesetzt.</para>
3974 <para>Die unterstützen Formatierungen sind:</para>
3978 <term><b>Text</b></term>
3981 <para>Text wird in Fettdruck gesetzt.</para>
3986 <term><i>Text</i></term>
3989 <para>Text wird kursiv gesetzt.</para>
3994 <term><u>Text</u></term>
3997 <para>Text wird unterstrichen.</para>
4002 <term><s>Text</s></term>
4005 <para>Text wird durchgestrichen. Diese Formatierung ist nicht
4006 bei der Ausgabe als PDF über LaTeX verfügbar.</para>
4011 <term><bullet></term>
4014 <para>Erzeugt einen ausgefüllten Kreis für Aufzählungen (siehe
4020 <para>Der Befehl <command><bullet></command> funktioniert
4021 momentan auch nur in Latex-Vorlagen.</para>
4025 <sect1 id="excel-templates">
4026 <title>Excel-Vorlagen</title>
4028 <sect2 id="excel-templates.summary">
4029 <title>Zusammenfassung</title>
4031 <para>Dieses Dokument beschreibt den Mechanismus, mit dem
4032 Exceltemplates abgearbeitet werden, und die Einschränkungen, die damit
4036 <sect2 id="excel-templates.usage">
4037 <title>Bedienung</title>
4039 <para>Der Excel Mechanismus muss in der Konfigurationsdatei aktiviert
4040 werden. Die Konfigurationsoption heißt <varname>excel_templates =
4041 1</varname> im Abschnitt <varname>[print_templates]</varname>.</para>
4043 <para>Eine Excelvorlage kann dann unter dem Namen einer beliebigen
4044 anderen Vorlage mit der Endung <filename>.xls</filename> gespeichert
4045 werden. In den normalen Verkaufsmasken taucht nun
4046 <constant>Excel</constant> als auswählbares Format auf und kann von da
4047 an wie LaTeX- oder OpenOffice-Vorlagen benutzt werden.</para>
4049 <para>Der Sonderfall der Angebote aus der Kundenmaske ist ebenfalls
4050 eine Angebotsvorlage und wird unter dem internen Namen der Angebote
4051 <filename>sales_quotation.xls</filename> gespeichert.</para>
4054 <sect2 id="excel-templates.syntax">
4055 <title>Variablensyntax</title>
4057 <para>Einfache Syntax:
4058 <command><<varname>></command></para>
4060 <para>Dabei sind <constant><<</constant> und
4061 <constant>>></constant> die Delimiter. Da Excel auf festen
4062 Breiten besteht, kann der Tag künstlich verlängert werden, indem
4063 weitere <constant><</constant> oder <constant>></constant>
4064 eingefügt werden. Der Tag muss nicht symmetrisch sein.
4067 <programlisting><<<<<varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4069 <para>Um die Limitierung der festen Breite zu reduzieren, können
4070 weitere Variablen in einem Block interpoliert werden. Whitespace wird
4071 dazwishen dann erhalten. Beispiel:</para>
4073 <programlisting><<<<<varname1 varname2 varname3>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4075 <para>Die Variablen werden interpoliert, und linksbündig mit
4076 Leerzeichen auf die gewünschte Länge aufgefüllt. Ist der String zu
4077 lang, werden überzählige Zeichen abgeschnitten.</para>
4079 <para>Es ist ausserdem möglich, Daten rechtsbündig darzustellen, wenn
4080 der Block mit einem Leerzeichen anfängt. Beispiel:</para>
4082 <programlisting><<<<<< varname>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>></programlisting>
4084 <para>Dies würde rechtsbündig triggern. Wenn bei rechtsbündiger
4085 Ausrichtung Text abgeschnitten werden muss, wird er vom linken Ende
4089 <sect2 id="excel-templates.limitations">
4090 <title>Einschränkungen</title>
4092 <para>Das Excelformat bis 2002 ist ein binäres Format, und kann nicht
4093 mit vertretbarem Aufwand editiert werden. Der Templatemechanismus
4094 beschränkt sich daher darauf, Textstellen exakt durch einen anderen
4095 Text zu ersetzen.</para>
4097 <para>Aus dem gleichen Grund sind die Kontrolllstrukturen
4098 <command><%if%></command> und
4099 <command><%foreach%></command> nicht vorhanden. Der Delimiter
4100 <constant><% %></constant> kommt in den Headerinformationen
4101 evtl. vor. Deshalb wurde auf den sichereren Delimiter
4102 <constant><<</constant> und <constant>>></constant>
4109 <title>Entwicklerdokumentation</title>
4111 <sect1 id="devel.globals" xreflabel="Globale Variablen">
4112 <title>Globale Variablen</title>
4115 <title>Wie sehen globale Variablen in Perl aus?</title>
4117 <para>Globale Variablen liegen in einem speziellen namespace namens
4118 "main", der von überall erreichbar ist. Darüber hinaus sind bareword
4119 globs global und die meisten speziellen Variablen sind...
4122 <para>Daraus ergeben sich folgende Formen:</para>
4126 <term><literal>$main::form</literal></term>
4129 <para>expliziter Namespace "main"</para>
4134 <term><literal>$::form</literal></term>
4137 <para>impliziter Namespace "main"</para>
4142 <term><literal>open FILE, "file.txt"</literal></term>
4145 <para><varname>FILE</varname> ist global</para>
4150 <term><literal>$_</literal></term>
4153 <para>speziell</para>
4158 <para>Im Gegensatz zu <productname>PHP</productname> gibt es kein
4159 Schlüsselwort wie "<function>global</function>", mit dem man
4160 importieren kann. <function>my</function>, <function>our</function>
4161 und <function>local</function> machen was anderes.</para>
4165 <term><literal>my $form</literal></term>
4168 <para>lexikalische Variable, gültig bis zum Ende des
4174 <term><literal>our $form</literal></term>
4177 <para><varname>$form</varname> referenziert ab hier
4178 <varname>$PACKAGE::form</varname>.</para>
4183 <term><literal>local $form</literal></term>
4186 <para>Alle Änderungen an <varname>$form</varname> werden am Ende
4187 des scopes zurückgesetzt</para>
4194 <title>Warum sind globale Variablen ein Problem?</title>
4196 <para>Das erste Problem ist <productname>FCGI</productname>.</para>
4198 <para><productname>SQL-Ledger</productname> hat fast alles im globalen
4199 namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
4200 Unter <productname>FCGI</productname> müssen diese Sachen aber wieder
4201 aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
4202 Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
4203 Datenbankverbindungen, weil die sehr lange zum Initialisieren
4206 <para>Das zweite Problem ist <function>strict</function>. Unter
4207 <function>strict</function> werden alle Variablen die nicht explizit
4208 mit <function>Package</function>, <function>my</function> oder
4209 <function>our</function> angegeben werden als Tippfehler angemarkert,
4210 dies hat, seit der Einführung, u.a. schon so manche langwierige Bug-Suche verkürzt.
4211 Da globale Variablen aber implizit mit Package angegeben werden, werden
4212 die nicht geprüft, und somit kann sich schnell ein Tippfehler einschleichen.</para>
4216 <title>Kanonische globale Variablen</title>
4218 <para>Um dieses Problem im Griff zu halten gibt es einige wenige
4219 globale Variablen, die kanonisch sind, d.h. sie haben bestimmte vorgegebenen Eigenschaften,
4220 und alles andere sollte anderweitig umhergereicht werden.</para>
4222 <para>Diese Variablen sind im Moment die folgenden neun:</para>
4226 <para><varname>$::form</varname></para>
4230 <para><varname>%::myconfig</varname></para>
4234 <para><varname>$::locale</varname></para>
4238 <para><varname>$::lxdebug</varname></para>
4242 <para><varname>$::auth</varname></para>
4246 <para><varname>$::lx_office_conf</varname></para>
4250 <para><varname>$::instance_conf</varname></para>
4254 <para><varname>$::dispatcher</varname></para>
4258 <para><varname>$::request</varname></para>
4262 <para>Damit diese nicht erneut als Müllhalde missbraucht werden, im Folgenden
4263 eine kurze Erläuterung der bestimmten vorgegebenen Eigenschaften (Konventionen):</para>
4266 <title>$::form</title>
4270 <para>Ist ein Objekt der Klasse
4271 "<classname>Form</classname>"</para>
4275 <para>Wird nach jedem Request gelöscht</para>
4279 <para>Muss auch in Tests und Konsolenscripts vorhanden
4284 <para>Enthält am Anfang eines Requests die Requestparameter vom
4289 <para>Kann zwar intern über Requestgrenzen ein Datenbankhandle
4290 cachen, das wird aber momentan absichtlich zerstört</para>
4294 <para><varname>$::form</varname> wurde unter <productname>SQL
4295 Ledger</productname> als Gottobjekt für alles misbraucht. Sämtliche
4296 alten Funktionen unter SL/ mutieren <varname>$::form</varname>, das
4297 heißt, alles was einem lieb ist (alle Variablen die einem ans Herz
4298 gewachsen sind), sollte man vor einem Aufruf (!) von zum
4299 Beispiel <function>IS->retrieve_customer()</function> in
4300 Sicherheit bringen. </para>
4303 Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man Berechnung in einem
4304 bestimmten Format durchführt (SL/Form.pm Zeile 3552, Stand version 2.7beta), um
4305 dies hinterher wieder auf den richtigen Wert zu setzen:
4308 <programlisting> my $saved_numberformat = $::myconfig{numberformat};
4309 $::myconfig{numberformat} = $numberformat;
4310 # (...) div Berechnungen
4311 $::myconfig{numberformat} = $saved_numberformat;</programlisting>
4314 Das Objekt der Klasse Form hat leider im Moment noch viele zentrale Funktionen die vom internen Zustand abhängen, deshalb bitte
4315 nie einfach zerstören oder überschreiben (zumindestens nicht kurz vor einem Release oder in Absprache über bspw. die devel-Liste
4316 ;-). Es geht ziemlich sicher etwas kaputt.
4320 <varname>$::form</varname> ist gleichzeitig der Standard Scope in den <productname>Template::Toolkit</productname> Templates
4321 außerhalb der Controller: der Ausdruck <function>[% var %]</function> greift auf <varname>$::form->{var}</varname> zu. Unter
4322 Controllern ist der Standard Scope anders, da lautet der Zugriff <function>[% FORM.var %]</function>. In Druckvorlagen sind
4323 normale Variablen ebenfall im <varname>$::form</varname> Scope, d.h. <function><%var%></function> zeigt auf
4324 <varname>$::form->{var}</varname>. Nochmal von der anderen Seite erläutert, innerhalb von (Web-)Templates sieht man häufiger
4328 <programlisting>[%- IF business %]
4329 # (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
4330 [%- END %]</programlisting>
4333 Entweder wird hier dann $::form->{business} ausgewertet oder aber der Funktion <function>$form->parse_html_template</function>
4334 wird explizit noch ein zusätzlicher Hash übergeben, der dann auch in den (Web-)Templates zu Verfügung steht, bspw. so:
4337 <programlisting>$form->parse_html_template("is/form_header", \%TMPL_VAR);</programlisting>
4340 Innerhalb von Schleifen wird <varname>$::form->{TEMPLATE_ARRAYS}{var}[$index]</varname> bevorzugt, wenn vorhanden. Ein
4341 Beispiel findet sich in SL/DO.pm, welches über alle Positionen eines Lieferscheins in Schleife läuft:
4344 <programlisting>for $i (1 .. $form->{rowcount}) {
4346 push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} }, $position;
4347 push @{ $form->{TEMPLATE_ARRAYS}{number} }, $form->{"partnumber_$i"};
4348 push @{ $form->{TEMPLATE_ARRAYS}{description} }, $form->{"description_$i"};
4354 <title>%::myconfig</title>
4358 <para>Das einzige Hash unter den globalen Variablen</para>
4362 <para>Wird spätestens benötigt wenn auf die Datenbank
4363 zugegriffen wird</para>
4367 <para>Wird bei jedem Request neu erstellt.</para>
4371 <para>Enthält die Userdaten des aktuellen Logins</para>
4375 <para>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
4376 extern serialisiert werden, weil da auch der Datenbankzugriff
4377 für diesen user drinsteht.</para>
4381 <para>Enthält unter anderem Listenbegrenzung vclimit,
4382 Datumsformat dateformat und Nummernformat numberformat</para>
4386 <para>Enthält Datenbankzugriffinformationen</para>
4391 <varname>%::myconfig</varname> ist im Moment der Ersatz für ein Userobjekt. Die meisten Funktionen, die etwas anhand des
4392 aktuellen Users entscheiden müssen, befragen <varname>%::myconfig</varname>. Innerhalb der Anwendungen sind dies überwiegend die
4393 Daten, die sich unter <guimenu>Programm</guimenu> -> <guimenuitem>Einstellungen</guimenuitem> befinden, bzw. die Informationen
4394 über den Benutzer die über die Administrator-Schnittstelle (admin.pl) eingegeben wurden.
4399 <title>$::locale</title>
4403 <para>Objekt der Klasse "Locale"</para>
4407 <para>Wird pro Request erstellt</para>
4411 <para>Muss auch für Tests und Scripte immer verfügbar
4416 <para>Cached intern über Requestgrenzen hinweg benutzte
4421 <para>Lokalisierung für den aktuellen User. Alle Übersetzungen,
4422 Zahlen- und Datumsformatierungen laufen über dieses Objekt.</para>
4426 <title>$::lxdebug</title>
4430 <para>Objekt der Klasse "LXDebug"</para>
4434 <para>Wird global gecached</para>
4438 <para>Muss immer verfügbar sein, in nahezu allen
4444 <varname>$::lxdebug</varname> stellt Debuggingfunktionen bereit, wie "<function>enter_sub</function>" und
4445 "<function>leave_sub</function>", mit denen in den alten Modulen ein brauchbares Tracing gebaut ist,
4446 "<function>log_time</function>", mit der man die Wallclockzeit seit Requeststart loggen kann, sowie
4447 "<function>message</function>" und "<function>dump</function>" mit denen man flott Informationen ins Log
4448 (tmp/lx-office-debug.log) packen kann.
4455 <programlisting>$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
4456 $main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});</programlisting>
4460 <title>$::auth</title>
4464 <para>Objekt der Klasse "SL::Auth"</para>
4468 <para>Wird global gecached</para>
4472 <para>Hat eine permanente DB Verbindung zur Authdatenbank</para>
4476 <para>Wird nach jedem Request resettet.</para>
4480 <para><varname>$::auth</varname> stellt Funktionen bereit um die
4481 Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
4482 vom aktuellen User abhängen wird das Objekt aus
4483 Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
4484 Request kurz resettet.</para>
4488 <title>$::lx_office_conf</title>
4492 <para>Objekt der Klasse
4493 "<classname>SL::LxOfficeConf</classname>"</para>
4497 <para>Global gecached</para>
4501 <para>Repräsentation der
4502 <filename>config/lx_office.conf[.default]</filename>-Dateien</para>
4506 <para>Globale Konfiguration. Configdateien werden zum Start gelesen
4507 und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass das
4508 Programm die Konfiguration ändern kann oder sollte.</para>
4510 <para>Beispielsweise ist über den Konfigurationseintrag [debug]
4511 die Debug- und Trace-Log-Datei wie folgt konfiguriert und verfügbar:</para>
4513 <programlisting>[debug]
4514 file = /tmp/lx-office-debug.log</programlisting>
4516 <para>ist der Key <varname>file</varname> im Programm als
4517 <varname>$::lx_office_conf->{debug}{file}</varname>
4521 <para>Zugriff auf die Konfiguration erfolgt im Moment über
4522 Hashkeys, sind also nicht gegen Tippfehler abgesichert.</para>
4527 <title>$::instance_conf</title>
4531 <para>Objekt der Klasse
4532 "<classname>SL::InstanceConfiguration</classname>"</para>
4536 <para>wird pro Request neu erstellt</para>
4540 <para>Funktioniert wie <varname>$::lx_office_conf</varname>,
4541 speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
4542 ist hier eine Mandantendatenbank.
4543 Beispielsweise überprüft
4544 <programlisting>$::instance_conf->get_inventory_system eq 'perpetual'</programlisting>
4545 ob die berüchtigte Bestandsmethode zur Anwendung kommt.</para>
4549 <title>$::dispatcher</title>
4553 <para>Objekt der Klasse
4554 "<varname>SL::Dispatcher</varname>"</para>
4558 <para>wird pro Serverprozess erstellt.</para>
4562 <para>enthält Informationen über die technische Verbindung zum
4567 <para>Der dritte Punkt ist auch der einzige Grund warum das Objekt
4568 global gespeichert wird. Wird vermutlich irgendwann in einem anderen
4569 Objekt untergebracht.</para>
4573 <title>$::request</title>
4577 <para>Hashref (evtl später Objekt)</para>
4581 <para>Wird pro Request neu initialisiert.</para>
4585 <para>Keine Unterstruktur garantiert.</para>
4589 <para><varname>$::request</varname> ist ein generischer Platz um
4590 Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
4591 at a distance benutzt werden, sondern um lokales memoizing zu
4592 ermöglichen, das garantiert am Ende des Requests zerstört
4595 <para>Vieles von dem, was im moment in <varname>$::form</varname>
4596 liegt, sollte eigentlich hier liegen. Die groben
4597 Differentialkriterien sind:</para>
4601 <para>Kommt es vom User, und soll unverändert wieder an den User? Dann <varname>$::form</varname>, steht da eh schon</para>
4605 <para>Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann
4606 <varname>$::request</varname></para>
4610 <para>Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann <varname>$::request</varname>, aber Zugriff über
4611 Wrappermethode</para>
4618 <title>Ehemalige globale Variablen</title>
4620 <para>Die folgenden Variablen waren einmal im Programm, und wurden
4624 <title>$::cgi</title>
4628 <para>war nötig, weil cookie Methoden nicht als
4629 Klassenfunktionen funktionieren</para>
4633 <para>Aufruf als Klasse erzeugt Dummyobjekt was im
4634 Klassennamespace gehalten wird und über Requestgrenzen
4639 <para>liegt jetzt unter
4640 <varname>$::request->{cgi}</varname></para>
4646 <title>$::all_units</title>
4650 <para>war nötig, weil einige Funktionen in Schleifen zum Teil
4651 ein paar hundert mal pro Request eine Liste der Einheiten
4652 brauchen, und de als Parameter durch einen Riesenstack von
4653 Funktionen geschleift werden müssten.</para>
4657 <para>Liegt jetzt unter
4658 <varname>$::request->{cache}{all_units}</varname></para>
4663 <function>AM->retrieve_all_units()</function> gesetzt oder
4670 <title>%::called_subs</title>
4674 <para>wurde benutzt um callsub deep recursions
4679 <para>Wurde entfernt, weil callsub nur einen Bruchteil der
4680 möglichen Rekursioenen darstellt, und da nie welche
4685 <para>komplette recursion protection wurde entfernt.</para>
4692 <sect1 id="devel.fcgi">
4693 <title>Entwicklung unter FastCGI</title>
4695 <sect2 id="devel.fcgi.general">
4696 <title>Allgemeines</title>
4698 <para>Wenn Änderungen in der Konfiguration von Lx-Office gemacht
4699 werden, muss der Webserver neu gestartet werden.</para>
4701 <para>Bei der Entwicklung für FastCGI ist auf ein paar Fallstricke zu
4702 achten. Dadurch, dass das Programm in einer Endlosschleife läuft,
4703 müssen folgende Aspekte beachtet werden.</para>
4706 <sect2 id="devel.fcgi.exiting">
4707 <title>Programmende und Ausnahmen</title>
4709 <para>Betrifft die Funktionen <function>warn</function>,
4710 <function>die</function>, <function>exit</function>,
4711 <function>carp</function> und <function>confess</function>.</para>
4713 <para>Fehler, die dass Programm normalerweise sofort beenden (fatale
4714 Fehler), werden mit dem FastCGI Dispatcher abgefangen, um das Programm
4715 am Laufen zu halten. Man kann mit <function>die</function>,
4716 <function>confess</function> oder <function>carp</function> Fehler
4717 ausgeben, die dann vom Dispatcher angezeigt werden. Die Lx-Office
4718 eigene <function>$::form-</function>error()> tut im Prinzip das
4719 Gleiche, mit ein paar Extraoptionen. <function>warn</function> und
4720 <function>exit</function> hingegen werden nicht abgefangen.
4721 <function>warn</function> wird direkt nach STDERR, also in Server Log
4722 eine Nachricht schreiben (sofern in der Konfiguration nicht die
4723 Warnungen in das Lx-Office Log umgeleitet wurden), und
4724 <function>exit</function> wird die Ausführung beenden.</para>
4726 <para>Prinzipiell ist es kein Beinbruch, wenn sich der Prozess
4727 beendet, fcgi wird ihn sofort neu starten. Allerdings sollte das die
4728 Ausnahme sein. Quintessenz: Bitte kein <function>exit</function>
4729 benutzen, alle anderen Exceptionmechanismen sind ok.</para>
4732 <sect2 id="devel.fcgi.globals">
4733 <title>Globale Variablen</title>
4735 <para>Um zu vermeiden, dass Informationen von einem Request in einen
4736 anderen gelangen, müssen alle globalen Variablen vor einem Request
4737 sauber initialisiert werden. Das ist besonders wichtig im
4738 <varname>$::cgi</varname> und <varname>$::auth</varname> Objekt, weil
4739 diese nicht gelöscht werden pro Instanz, sondern persistent gehalten
4742 <para>In <classname>SL::Dispatcher</classname> gibt es einen sauber
4743 abgetrennten Block, der alle kanonischen globalen Variablen listet und
4744 erklärt. Bitte keine anderen einführen ohne das sauber zu
4745 dokumentieren.</para>
4747 <para>Datenbankverbindungen wird noch ein Guide verfasst werden, wie
4748 man sicher geht, dass man die richtige erwischt.</para>
4751 <sect2 id="devel.fcgi.performance">
4752 <title>Performance und Statistiken</title>
4754 <para>Die kritischen Pfade des Programms sind die Belegmasken, und
4755 unter diesen ganz besonders die Verkaufsrechnungsmaske. Ein Aufruf der
4756 Rechnungsmaske in Lx-Office 2.4.3 stable dauert auf einem Core2duo mit
4757 4GB Arbeitsspeicher und Ubuntu 9.10 eine halbe Sekunde. In der 2.6.0
4758 sind es je nach Menge der definierten Variablen 1-2s. Ab der
4759 Moose/Rose::DB Version sind es 5-6s.</para>
4761 <para>Mit FastCGI ist die neuste Version auf 0,26 Sekunden selbst in
4762 den kritischen Pfaden, unter 0,15 sonst.</para>
4765 <sect2 id="devel.fcgi.known-issues">
4766 <title>Bekannte Probleme</title>
4768 <sect3 id="devel.fcgi.known-issues.encoding">
4769 <title>Encoding Awareness</title>
4771 <para>UTF-8 kodierte Installationen sind sehr anfällig gegen
4772 fehlerhfate Encodings unter FCGI. latin9 Installationen behandeln
4773 falsch kodierte Zeichen eher unwissend, und geben sie einfach
4774 weiter. UTF-8 verweigert bei fehlerhaften Programmpfaden kurzerhand
4775 das Ausliefern. Es wird noch daran gearbeitet, alle Fehler da zu
4781 <sect1 id="db-upgrade-files" xreflabel="Datenbank-Upgradedateien">
4782 <title>SQL-Upgradedateien</title>
4784 <sect2 id="db-upgrade-files.introduction" xreflabel="Einführung in die Datenbank-Upgradedateien">
4785 <title>Einführung</title>
4788 Der alte Mechanismus für SQL-Upgradescripte, der auf einer Versionsnummer beruht und dann in sql/Pg-upgrade nach einem Script für
4789 diese Versionsnummer sucht, schränkt sehr ein, z.B. was die parallele Entwicklung im stable- und unstable-Baum betrifft.
4793 Dieser Mechanismus wurde für Lx-Office 2.4.1 deutlich erweitert. Es werden weiterhin alle Scripte aus sql/Pg-upgrade
4794 ausgeführt. Zusätzlich gibt es aber ein zweites Verzeichnis, sql/Pg-upgrade2. In diesem Verzeichnis muss pro Datenbankupgrade eine
4795 Datei existieren, die neben den eigentlich auszuführenden SQL- oder Perl-Befehlen einige Kontrollinformationen enthält.
4799 Neu sind die Kontrollinformationen, die Abhängigkeiten und Prioritäten definieren können werden, sodass Datenbankscripte zwar in
4800 einer sicheren Reihenfolge ausgeführt werden (z.B. darf ein "ALTER TABLE" erst ausgeführt werden, wenn die Tabelle mit "CREATE TABLE"
4801 angelegt wurde), diese Reihenfolge aber so flexibel ist, dass man keine Versionsnummern mehr braucht.
4805 Lx-Office merkt sich dabei, welches der Upgradescripte in sql/Pg-upgrade2 bereits durchgeführt wurde und führt diese nicht erneut
4806 aus. Dazu dient die Tabelle "schema_info", die bei der Anmeldung automatisch angelegt wird.
4810 <sect2 id="db-upgrade-files.format" xreflabel="Format der Upgradedateien">
4811 <title>Format der Kontrollinformationen</title>
4814 Die Kontrollinformationen sollten sich am Anfang der jeweiligen Upgradedatei befinden. Jede Zeile, die Kontrollinformationen enthält,
4815 hat dabei das folgende Format:
4819 Für SQL-Upgradedateien:
4822 <programlisting>-- @key: value</programlisting>
4825 Für Perl-Upgradedateien:
4828 <programlisting># @key: value</programlisting>
4831 Leerzeichen vor "<varname>value</varname>" werden entfernt.
4835 Die folgenden Schlüsselworte werden verarbeitet:
4840 <term><varname>tag</varname></term>
4843 Wird zwingend benötigt. Dies ist der "Name" des Upgrades. Dieser "tag" kann von anderen Kontrolldateien in ihren Abhängigkeiten
4844 verwendet werden (Schlüsselwort "<varname>depends</varname>"). Der "tag" ist auch der Name, der in der Datenbank eingetragen wird.
4848 Normalerweise sollte die Kontrolldatei genau so heißen wie der "tag", nur mit der Endung ".sql" bzw. "pl".
4852 Ein Tag darf nur aus alphanumerischen Zeichen sowie den Zeichen _ - ( ) bestehen. Insbesondere sind Leerzeichen nicht erlaubt und
4853 sollten stattdessen mit Unterstrichen ersetzt werden.
4859 <term><varname>charset</varname></term>
4862 Empfohlen. Gibt den Zeichensatz an, in dem das Script geschrieben wurde, z.B. "<literal>UTF-8</literal>". Aus
4863 Kompatibilitätsgründen mit alten Upgrade-Scripten wird bei Abwesenheit des Tags der Zeichensatz "<literal>ISO-8859-15</literal>"
4870 <term><varname>description</varname></term>
4873 Benötigt. Eine Beschreibung, was in diesem Update passiert. Diese wird dem Benutzer beim eigentlichen Datenbankupdate
4874 angezeigt. Während der Tag in englisch gehalten sein sollte, sollte die Beschreibung auf Deutsch erfolgen.
4880 <term><varname>depends</varname></term>
4883 Optional. Eine mit Leerzeichen getrennte Liste von "tags", von denen dieses Upgradescript abhängt. Lx-Office stellt sicher, dass
4884 die in dieser Liste aufgeführten Scripte bereits durchgeführt wurden, bevor dieses Script ausgeführt wird.
4888 Abhängigkeiten werden rekursiv betrachtet. Wenn also ein Script "b" existiert, das von Änderungen in "a" abhängt, und eine neue
4889 Kontrolldatei für "c" erstellt wird, die von Änderungen in "a" und "b" abhängt, so genügt es, in "c" nur den Tag "b" als
4890 Abhängigkeit zu definieren.
4894 Es ist nicht erlaubt, sich selbst referenzierende Abhängigkeiten zu definieren (z.B. "a" -> "b",
4895 "b" -> "c" und "c" -> "a").
4901 <term><varname>priority</varname></term>
4904 Optional. Ein Zahlenwert, der die Reihenfolge bestimmt, in der Scripte ausgeführt werden, die die gleichen Abhängigkeitstiefen
4905 besitzen. Fehlt dieser Parameter, so wird der Wert 1000 benutzt.
4909 Dies ist reine Kosmetik. Für echte Reihenfolgen muss "depends" benutzt werden. Lx-Office sortiert die auszuführenden Scripte
4910 zuerst nach der Abhängigkeitstiefe (wenn "z" von "y" abhängt und "y" von "x", so hat "z" eine Abhängigkeitstiefe von 2, "y" von 1
4911 und "x" von 0. "x" würde hier zuerst ausgeführt, dann "y", dann "z"), dann nach der Priorität und bei gleicher Priorität
4912 alphabetisch nach dem "tag".
4917 <term><varname>ignore</varname></term>
4920 Optional. Falls der Wert auf 1 (true) steht, wird das Skript bei der Anmeldung ignoriert und entsprechend nicht ausgeführt.
4927 <sect2 id="db-upgrade-files.dbupgrade-tool" xreflabel="Hilfsscript dbupgrade2_tool.pl">
4928 <title>Hilfsscript dbupgrade2_tool.pl</title>
4931 Um die Arbeit mit den Abhängigkeiten etwas zu erleichtern, existiert ein Hilfsscript namens
4932 "<filename>scripts/dbupgrade2_tool.pl</filename>". Es muss aus dem Lx-Office-ERP-Basisverzeichnis heraus aufgerufen werden. Dieses
4933 Tool liest alle Datenbankupgradescripte aus dem Verzeichnis <filename>sql/Pg-upgrade2</filename> aus. Es benutzt dafür die gleichen
4934 Methoden wie Lx-Office selber, sodass alle Fehlersituationen von der Kommandozeile überprüft werden können.
4938 Wird dem Script kein weiterer Parameter übergeben, so wird nur eine Überprüfung der Felder und Abhängigkeiten vorgenommen. Man kann
4939 sich aber auch Informationen auf verschiedene Art ausgeben lassen:
4944 <para>Listenform: "<command>./scripts/dbupgrade2_tool.pl --list</command>"</para>
4947 Gibt eine Liste aller Scripte aus. Die Liste ist in der Reihenfolge sortiert, in der Lx-Office die Scripte ausführen würde. Es
4948 werden neben der Listenposition der Tag, die Abhängigkeitstiefe und die Priorität ausgegeben.
4953 <para>Baumform: "<command>./scripts/dbupgrade2_tool.pl --tree</command>"</para>
4956 Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte, von denen keine
4957 anderen abhängen. Die Unterknoten sind Scripte, die beim übergeordneten Script als Abhängigkeit eingetragen sind.
4961 <listitem id="db-upgrade-files.dbupgrade-tool.reverse-tree">
4962 <para>Umgekehrte Baumform: "<command>./scripts/dbupgrade2_tool.pl --rtree</command>"</para>
4965 Listet alle Tags in Baumform basierend auf den Abhängigkeiten auf. Die "Wurzelknoten" sind dabei die Scripte mit der geringsten
4966 Abhängigkeitstiefe. Die Unterknoten sind Scripte, die das übergeordnete Script als Abhängigkeit eingetragen haben.
4971 <para>Baumform mit Postscriptausgabe: "<command>./scripts/dbupgrade2_tool.pl --graphviz</command>"</para>
4974 Benötigt das Tool "<command>graphviz</command>", um mit seiner Hilfe die <link
4975 linkend="db-upgrade-files.dbupgrade-tool.reverse-tree">umgekehrte Baumform</link> in eine Postscriptdatei namens
4976 "<filename>db_dependencies.ps</filename>" auszugeben. Dies ist vermutlich die übersichtlichste Form, weil hierbei jeder Knoten nur
4977 einmal ausgegeben wird. Bei den Textmodusbaumformen hingegen können Knoten und all ihre Abhängigkeiten mehrfach ausgegeben werden.
4983 Scripte, von denen kein anderes Script abhängt: "<command>./scripts/dbupgrade2_tool.pl --nodeps</command>"
4987 Listet die Tags aller Scripte auf, von denen keine anderen Scripte abhängen.
4994 <sect1 id="translations-languages" xreflabel="Translations and languages">
4995 <title>Translations and languages</title>
4997 <sect2 id="translations-languages.introduction"
4998 xreflabel="Introduction to translations and languages">
4999 <title>Introduction</title>
5002 <para>Dieser Abschnitt ist in Englisch geschrieben, um
5003 internationalen Übersetzern die Arbeit zu erleichtern.</para>
5006 <para>This section describes how localization packages in Lx-Office
5007 are built. Currently the only language fully supported is German, and
5008 since most of the internal messages are held in English the English
5009 version is usable too.</para>
5011 <para>A stub version of French is included but not functunal at this
5015 <sect2 id="translations-languages.file-structure"
5016 xreflabel="File structure">
5017 <title>File structure</title>
5019 <para>The structure of locales in Lx-Office is:</para>
5021 <programlisting>lx-office/locale/<langcode>/</programlisting>
5023 <para>where <langcode> stands for an abbreviation of the
5024 language package. The builtin packages use two letter <ulink
5025 url="http://en.wikipedia.org/wiki/ISO_639-1">ISO 639-1</ulink> codes,
5026 but the actual name is not relevant for the program and can easily be
5028 url="http://en.wikipedia.org/wiki/IETF_language_tag">IETF language
5029 tags</ulink> (i.e. "en_GB"). In fact the original language packages
5030 from SQL Ledger are named in this way.</para>
5032 <para>In such a language directory the following files are
5037 <term>LANGUAGE</term>
5040 <para>This file is mandatory.</para>
5042 <para>The <filename>LANGUAGE</filename> file contains the self
5043 descripted name of the language. It should contain a native
5044 representation first, and in parenthesis an english translation
5045 after that. Example:</para>
5047 <programlisting>Deutsch (German)</programlisting>
5052 <term>charset</term>
5055 <para>This file should be present.</para>
5057 <para>The <filename>charset</filename> file describes which
5058 charset a language package is written in and applies to all
5059 other language files in the package. It is possible to write
5060 some language packages without an explicit charset, but it is
5061 still strongly recommended. You'll never know in what
5062 environment your language package will be used, and neither
5063 UTF-8 nor Latin1 are guaranteed.</para>
5065 <para>The whole content of this file is a string that can be
5066 recognized as a valid charset encoding. Example:</para>
5068 <programlisting>UTF-8</programlisting>
5076 <para>This file is mandatory.</para>
5078 <para>The central translation file. It is essentially an inline
5079 Perl script autogenerated by <command>locales.pl</command>. To
5080 generate it, generate the directory and the two files mentioned
5081 above, and execute the following command:</para>
5083 <programlisting>scripts/locales.pl <langcode></programlisting>
5085 <para>Otherwise you can simply copy one of the other languages.
5086 You will be told how many are missing like this:</para>
5088 <programlisting>$ scripts/locales.pl en
5089 English - 0.6% - 2015/2028 missing</programlisting>
5091 <para>A file named "<filename>missing</filename>" will be
5092 generated and can be edited. You can also edit the
5093 "<filename>all</filename>" file directly. Edit everything you
5094 like to fit the target language and execute
5095 <command>locales.pl</command> again. See how the missing words
5101 <term>Num2text</term>
5104 <para>Legacy code from SQL Ledger. It provides a means for
5105 numbers to be converted into natural language, like
5106 <literal>1523 => one thousand five hundred twenty
5107 three</literal>. If you want to provide it, it must be inlinable
5108 Perl code which provides a <function>num2text</function> sub. If
5109 an <function>init</function> sub exists it will be executed
5112 <para>Only used in the check and receipt printing module.</para>
5117 <term>special_chars</term>
5120 <para>Lx-Office comes with a lot of interfaces to different
5121 formats, some of which are rather picky with their accepted
5122 charset. The <filename>special_chars</filename> file contains a
5123 listing of chars not suited for different file format and
5124 provides substitutions. It is written in "Simple Ini" style,
5125 containing a block for every file format.</para>
5127 <para>First entry should be the order of substitution for
5128 entries as a whitespace separated list. All entries are
5129 interpolated, so <literal>\n</literal>, <literal>\x20</literal>
5130 and <literal>\\</literal> all work.</para>
5132 <para>After that every entry is a special char that should be
5133 translated when writing text into such a file.</para>
5135 <para>Example:</para>
5137 <programlisting>[Template/XML]
5138 order=& < > \n
5142 \n=<br></programlisting>
5144 <para>Note the importance of the order in this example.
5145 Substituting < and > befor & would lead to $gt; become
5148 <para>For a list of valid formats, see the German
5149 <filename>special_chars</filename> entry. As of this writing the
5150 following are recognized:</para>
5152 <programlisting>HTML
5157 Template/OpenDocument
5158 filenames</programlisting>
5160 <para>The last of which is very machine dependant. Remember that
5161 a lot of characters are forbidden by some filesystems, for
5162 exmaple MS Windows doesn't like ':' in its files where Linux
5163 doesn't mind that. If you want the files created with your
5164 language pack to be portable, find all chars that could cause
5170 <term>missing</term>
5173 <para>This file is not a part of the language package
5176 <para>This is a file generated by
5177 <command>scripts/locales.pl</command> while processing your
5178 locales. It's only to have the missing entries singled out and
5179 does not belong to a language package.</para>
5187 <para>This file is not a part of the language package
5190 <para>Another file generated by
5191 <command>scripts/locales.pl</command>. If for any reason a
5192 translation does not appear anymore and can be deleted, it gets
5193 moved here. The last 50 or so entries deleted are saved here in
5194 case you made a typo, so that you don't have to translate
5195 everything again. If a tranlsation is missing, the lost file is
5196 checked first. If you maintain a language package, you might
5197 want to keep this safe somewhere.</para>
5204 <sect1 id="devel.style-guide">
5205 <title>Stil-Richtlinien</title>
5208 Die folgenden Regeln haben das Ziel, den Code möglichst gut les- und wartbar zu machen. Dazu gehört zum Einen, dass der Code
5209 einheitlich eingerückt ist, aber auch, dass Mehrdeutigkeit so weit es geht vermieden wird (Stichworte "Klammern" oder "Hash-Keys").
5213 Diese Regeln sind keine Schikane sondern erleichtern allen das Leben!
5217 Jeder, der einen Patch schickt, sollte seinen Code vorher überprüfen. Einige der Regeln lassen sich automatisch überprüfen, andere
5224 Es werden keine echten Tabs sondern Leerzeichen verwendet.
5230 Die Einrückung beträgt zwei Leerzeichen. Beispiel:
5233 <programlisting>foreach my $row (@data) {
5235 # do something with $row
5239 $row->{modules} = MODULE->retrieve(
5240 id => $row->{id},
5241 date => $use_now ? localtime() : $row->{time},
5245 $report->add($row);
5250 <para>Öffnende geschweifte Klammern befinden sich auf der gleichen Zeile wie der letzte Befehl. Beispiele:</para>
5252 <programlisting>sub debug {
5258 <programlisting>if ($form->{item_rows} > 0) {
5265 Schließende geschweifte Klammern sind so weit eingerückt wie der Befehl / die öffnende schließende Klammer, die den Block gestartet
5266 hat, und nicht auf der Ebene des Inhalts. Die gleichen Beispiele wie bei 3. gelten.
5272 Die Wörter "<function>else</function>", "<function>elsif</function>", "<function>while</function>" befinden sich auf der gleichen
5273 Zeile wie schließende geschweifte Klammern. Beispiele:
5276 <programlisting>if ($form->{sum} > 1000) {
5278 } elsif ($form->{sum} > 0) {
5286 } until ($a > 0);</programlisting>
5291 Parameter von Funktionsaufrufen müssen mit runden Klammern versehen werden. Davon nicht betroffen sind interne Perl-Funktionen,
5292 und grep-ähnliche Operatoren. Beispiel:
5295 <programlisting>$main::lxdebug->message("Could not find file.");
5296 %options = map { $_ => 1 } grep { !/^#/ } @config_file;</programlisting>
5301 Verschiedene Klammern, Ihre Ausdrücke und Leerzeichen:
5305 Generell gilt: Hashkeys und Arrayindices sollten nicht durch Leerzeichen abgesetzt werden. Logische Klammerungen ebensowenig,
5306 Blöcke schon. Beispiel:
5309 <programlisting>if (($form->{debug} == 1) && ($form->{sum} - 100 < 0)) {
5314 $form->{sum} += $form->{"row_$i"};
5315 $form->{ $form->{index} } += 1;
5317 map { $form->{sum} += $form->{"row_$_"} } 1..$rowcount;</programlisting>
5328 Werden die Parameter eines Funktionsaufrufes auf mehrere Zeilen aufgeteilt, so sollten diese bis zu der Spalte eingerückt
5329 werden, in der die ersten Funktionsparameter in der ersten Zeile stehen. Beispiel:
5332 <programlisting>$sth = $dbh->prepare("SELECT * FROM some_table WHERE col = ?",
5333 $form->{some_col_value});</programlisting>
5338 Ein Spezialfall ist der ternäre Oprator "?:", der am besten in einer übersichtlichen Tabellenstruktur organisiert
5342 <programlisting>my $rowcount = $form->{"row_$i"} ? $i
5343 : $form->{oldcount} ? $form->{oldcount} + 1
5344 : $form->{rowcount} - $form->{rowbase};</programlisting>
5356 <para>Kommentare, die alleine in einer Zeile stehen, sollten soweit wie der Code eingerückt sein.</para>
5360 <para>Seitliche hängende Kommentare sollten einheitlich formatiert werden.</para>
5365 Sämtliche Kommentare und Sonstiges im Quellcode ist bitte auf Englisch zu verfassen. So wie ich keine Lust habe, französischen
5366 Quelltext zu lesen, sollte auch der Lx-Office Quelltext für nicht-Deutschsprachige lesbar sein. Beispiel:
5369 <programlisting>my $found = 0;
5377 $i = 0 # initialize $i
5379 $i *= $const; # do something crazy
5380 $i = $n; # recover $i</programlisting>
5387 Hashkeys sollten nur in Anführungszeichen stehen, wenn die Interpolation gewünscht ist. Beispiel:
5390 <programlisting>$form->{sum} = 0;
5391 $form->{"row_$i"} = $form->{"row_$i"} - 5;
5392 $some_hash{42} = 54;</programlisting>
5397 Die maximale Zeilenlänge ist nicht beschränkt. Zeilenlängen unterhalb von 79 Zeichen helfen unter bestimmten Bedingungen, aber
5398 wenn die Lesbarkeit unter kurzen Zeilen leidet (wie zum Biespiel in grossen Tabellen), dann ist Lesbarkeit vorzuziehen.
5402 Als Beispiel sei die Funktion <function>print_options</function> aus <filename>bin/mozilla/io.pl</filename> angeführt.
5408 Trailing Whitespace, d.h. Leerzeichen am Ende von Zeilen sind unerwünscht. Sie führen zu unnötigen Whitespaceänderungen, die
5413 Emacs und vim haben beide recht einfache Methoden zur Entfernung von trailing whitespace. Emacs kennt das Kommande
5414 <command>nuke-trailing-whitespace</command>, vim macht das gleiche manuell über <literal>:%s/\s\+$//e</literal> Mit <literal>:au
5415 BufWritePre * :%s/\s\+$//e</literal> wird das an Speichern gebunden.
5421 Es wird kein <command>perltidy</command> verwendet.
5425 In der Vergangenheit wurde versucht, <command>perltidy</command> zu verwenden, um einen einheitlichen Stil zu erlangen. Es hat
5426 sich aber gezeigt, dass <command>perltidy</command>s sehr eigenwilliges Verhalten, was Zeilenumbrüche angeht, oftmals gut
5427 formatierten Code zerstört. Für den Interessierten sind hier die <command>perltidy</command>-Optionen, die grob den
5428 beschriebenen Richtlinien entsprechen:
5431 <programlisting>-syn -i=2 -nt -pt=2 -sbt=2 -ci=2 -ibc -hsc -noll -nsts -nsfs -asc -dsm
5432 -aws -bbc -bbs -bbb -mbl=1 -nsob -ce -nbl -nsbl -cti=0 -bbt=0 -bar -l=79
5433 -lp -vt=1 -vtc=1</programlisting>
5438 <varname>STDERR</varname> ist tabu. Unkonditionale Debugmeldungen auch.
5442 Lx-Office bietet mit dem Modul <classname>LXDebug</classname> einen brauchbaren Trace-/Debug-Mechanismus. Es gibt also keinen
5443 Grund, nach <varname>STDERR</varname> zu schreiben.
5447 Die <classname>LXDebug</classname>-Methode "<function>message</function>" nimmt als ersten Paramter außerdem eine Flagmaske, für
5448 die die Meldung angezeigt wird, wobei "0" immer angezeigt wird. Solche Meldungen sollten nicht eingecheckt werden und werden in
5449 den meisten Fällen auch vom Repository zurückgewiesen.
5455 Alle neuen Module müssen use strict verwenden.
5459 <varname>$form</varname>, <varname>$auth</varname>, <varname>$locale</varname>, <varname>$lxdebug</varname> und
5460 <varname>%myconfig</varname> werden derzeit aus dem main package importiert (siehe <xref linkend="devel.globals"/>. Alle anderen
5461 Konstrukte sollten lexikalisch lokal gehalten werden.
5467 <sect1 id="devel.build-doc" xreflabel="Dokumentation erstellen">
5468 <title>Dokumentation erstellen</title>
5470 <sect2 id="devel.build-doc.introduction">
5471 <title>Einführung</title>
5474 Diese Dokumentation ist in <productname>DocBook</productname> XML geschrieben. Zum Bearbeiten reicht grundsätzlich ein
5475 Text-Editor. Mehr Komfort bekommt man, wenn man einen dedizierten XML-fähigen Editor nutzt, der spezielle Unterstützung für
5476 <productname>DocBook</productname> mitbringt. Wir empfehlen dafür den <ulink url="http://www.xmlmind.com/xmleditor/">XMLmind XML
5477 Editor</ulink>, der bei nicht kommerzieller Nutzung kostenlos ist.
5481 <sect2 id="devel.build-doc.required-software">
5482 <title>Benötigte Software</title>
5485 Bei <productname>DocBook</productname> ist Prinzip, dass ausschließlich die XML-Quelldatei bearbeitet wird. Aus dieser werden dann
5486 mit entsprechenden Stylesheets andere Formate wie PDF oder HTML erzeugt. Bei Lx-Office übernimmt diese Aufgabe das Shell-Script
5487 <command>scripts/build_doc.sh</command>.
5491 Das Script benötigt zur Konvertierung verschiedene Softwarekomponenten, die im normalen Lx-Office-Betrieb nicht benötigt werden:
5497 <ulink url="http://www.oracle.com/technetwork/java/index.html">Java</ulink> in einer halbwegs aktuellen Version
5503 Das Java-Build-System <ulink url="http://ant.apache.org/">Apache Ant</ulink>
5509 Das Dokumentations-System Dobudish für <productname>DocBook</productname> 4.5, eine Zusammenstellung diverser Stylesheets und
5510 Grafiken zur Konvertierung von <productname>DocBook</productname> XML in andere Formate. Das Paket, das benötigt wird, ist zum
5511 Zeitpunkt der Dokumentationserstellung <filename>dobudish-nojre-1.1.4.zip</filename>, aus auf <ulink
5512 url="http://code.google.com/p/dobudish/downloads/list">code.google.com</ulink> bereitsteht.
5518 Apache Ant sowie ein dazu passendes Java Runtime Environment sind auf allen gängigen Plattformen verfügbar. Beispiel für
5522 <programlisting>apt-get install ant openjdk-7-jre</programlisting>
5525 Nach dem Download von Dobudish muss Dobudish im Unterverzeichnis <filename>doc/build</filename> entpackt werden. Beispiel unter der
5526 Annahme, das <productname>Dobudish</productname> in <filename>$HOME/Downloads</filename> heruntergeladen wurde:
5529 <programlisting>cd doc/build
5530 unzip $HOME/Downloads/dobudish-nojre-1.1.4.zip</programlisting>
5533 <sect2 id="devel.build-doc.build">
5534 <title>PDFs und HTML-Seiten erstellen</title>
5537 Die eigentliche Konvertierung erfolgt nach Installation der benötigten Software mit einem einfachen Aufruf direkt aus dem
5538 Lx-Office-Installationsverzeichnis heraus:
5541 <programlisting>./scripts/build_doc.sh</programlisting>
5544 <sect2 id="devel.build-doc.repository">
5545 <title>Einchecken in das Git-Repository</title>
5548 Sowohl die XML-Datei als auch die erzeugten PDF- und HTML-Dateien sind Bestandteil des Git-Repositories. Daraus folgt, dass nach
5549 Änderungen am XML die PDF- und HTML-Dokumente ebenfalls gebaut und alles zusammen in einem Commit eingecheckt werden sollten.
5553 Die "<filename>dobudish</filename>"-Verzeichnisse bzw. symbolischen Links gehören hingegen nicht in das Repository.