2.13. OpenDocument-Vorlagen
kivitendo unterstützt die Verwendung von Vorlagen im
- OpenDocument-Format, wie es LibreOffice oder OpenOffice (ab Version 2)
- erzeugen. kivitendo kann dabei sowohl neue OpenDocument-Dokumente als
- auch aus diesen direkt PDF-Dateien erzeugen. Um die Unterstützung von
- OpenDocument-Vorlagen zu aktivieren muss in der Datei
- config/kivitendo.conf die Variable
- opendocument im Abschnitt
- print_templates auf â1â stehen.
- Dieses ist die Standardeinstellung.
Während die Erzeugung von reinen OpenDocument-Dateien keinerlei
- weitere Software benötigt, wird zur Umwandlung dieser Dateien in PDF
- LibreOffice oder OpenOffice benötigt. Soll dieses Feature genutzt
- werden, so muss neben LibreOffice oder OpenOffice auch der âX virtual
- frame bufferâ (xvfb) installiert werden. Bei Debian ist er im Paket
- âxvfbâ enthalten. Andere Distributionen enthalten ihn in anderen
- Paketen.
Nach der Installation müssen in der Datei
- config/kivitendo.conf im Abschnitt
- applications zwei weitere Variablen angepasst
- werden:
- openofficeorg_writer muss den vollständigen
- Pfad zu LibreOffice oder OpenOffice enthalten. Dabei dürfen keine
- Anführungszeichen eingesetzt werden.
Beispiel für Debian oder Ubuntu:
openofficeorg_writer = /usr/bin/libreoffice
- xvfb muss den Pfad zum âX virtual frame bufferâ
- enthalten.
Zusätzlich gibt es zwei verschiedene Arten, wie kivitendo mit
- LibreOffice bzw. OpenOffice kommuniziert. Die erste Variante, die
- benutzt wird, wenn die Variable $openofficeorg_daemon
- gesetzt ist, startet ein LibreOffice oder OpenOffice, das auch nach der
- Umwandlung des Dokumentes gestartet bleibt. Bei weiteren Umwandlungen
- wird dann diese laufende Instanz benutzt. Der Vorteil ist, dass die Zeit
- zur Umwandlung deutlich reduziert wird, weil nicht für jedes Dokument
- ein LibreOffice bzw. OpenOffice gestartet werden muss. Der Nachteil ist,
- dass diese Methode Python und die Python-UNO-Bindings benötigt, die
- Bestandteil von LibreOffice bzw. OpenOffice sind.
![[Anmerkung]](system/docbook-xsl/images/note.png) | Anmerkung |
|---|
Für die Verbindung zu LibreOffice bzw. OpenOffice wird
- normalerweise der Python-Interpreter
- /usr/bin/python benutzt. Sollte dies nicht der
- richtige sein, so kann man mit zwei Konfigurationsvariablen
- entscheiden, welcher Python-Interpreter genutzt wird. Mit der Option
- python_uno aus dem Abschnitt
- applications wird der Interpreter selber
- festgelegt; sie steht standardmäÃig auf dem eben erwähnten Wert
- /usr/bin/python. Zusätzlich ist es möglich, Pfade anzugeben, in denen Python
- neben seinen normalen Suchpfaden ebenfalls nach Modulen gesucht wird,
- z.B. falls sich diese in einem gesonderten LibreOffice- bzw.
- OpenOffice-Verzeichnis befinden. Diese zweite Variable heiÃt
- python_uno_path und befindet sich im Abschnitt
- environment. Sie ist standardmäÃig leer. Werden
- hier mehrere Pfade angegeben, so müssen diese durch Doppelpunkte
- voneinander getrennt werden. Der Inhalt wird an den Python-Interpreter
- über die Umgebungsvariable PYTHONPATH
- übergeben. |
Ist $openofficeorg_daemon nicht gesetzt, so
- wird für jedes Dokument LibreOffice bzw. OpenOffice neu gestartet und
- die Konvertierung mit Hilfe eines Makros durchgeführt. Dieses Makro muss
- in der Dokumentenvorlage enthalten sein und
- âStandard.Conversion.ConvertSelfToPDF()â heiÃen. Die Beispielvorlage
- âtemplates/print/rev-odt/invoice.odtâ enthält ein
- solches Makro, das in jeder anderen Dokumentenvorlage ebenfalls
- enthalten sein muss.
Als letztes muss herausgefunden werden, welchen Namen OpenOffice
- bzw. LibreOffice dem Verzeichnis mit den Benutzereinstellungen gibt.
- Unter Debian ist dies momentan ~/.config/libreoffice.
- kivitendo verwendet das Verzeichnis
- users/.openoffice.org2. Eventuell muss dieses
- Verzeichnis umbenannt werden.
Dieses Verzeichnis, wie auch das komplette
- users-Verzeichnis, muss vom Webserver beschreibbar
- sein. Dieses wurde bereits erledigt (siehe Manuelle Installation des Programmpaketes), kann aber erneut
- überprüft werden, wenn die Konvertierung nach PDF fehlschlägt.
2.13.1. OpenDocument (odt) Druckvorlagen mit Makros
OpenDocument Vorlagen können Makros enthalten, welche komplexere
- Aufgaben erfüllen.
Der Vorlagensatz "rev-odt" enthält solche Vorlagen mit Schweizer Bank-Einzahlungsscheinen (BESR).
- Diese Makros haben die Aufgabe, die in den Einzahlungsscheinen
- benötigte Referenznummer und Kodierzeile zu erzeugen. Hier eine kurze
- Beschreibung, wie die Makros aufgebaut sind, und was bei ihrer Nutzung
- zu beachten ist (in fett sind nötige einmalige
- Anpassungen aufgeführt):
2.13.1.1. Bezeichnung der Vorlagen
Rechnung: invoice_besr.odt, Auftrag:
- sales_order_besr.odt
2.13.1.2. Vorbereitungen im Adminbereich
Damit beim Erstellen von Rechnungen und Aufträgen neben der
- Standardvorlage ohne Einzahlungsschein weitere Vorlagen (z.B. mit
- Einzahlungsschein) auswählbar sind, muss für jedes Vorlagen-Suffix
- ein Drucker eingerichtet werden:
Druckeradministration â Drucker hinzufügen
Mandant wählen
Druckerbeschreibung â aussagekräftiger Text: wird in der
- Auftrags- bzw. Rechnungsmaske als Auswahl angezeigt (z.B. mit
- Einzahlungsschein Bank xy)
Druckbefehl â beliebiger Text (hat für das Erzeugen von
- Aufträgen oder Rechnungen als odt-Datei keine Bedeutung, darf
- aber nicht leer sein)
Vorlagenkürzel â besr bzw. selbst gewähltes Vorlagensuffix
- (muss genau der Zeichenfolge entsprechen, die zwischen
- "invoice_" bzw. "sales_order_" und ".odt" steht.)
speichern
2.13.1.3. Benutzereinstellungen
Wer den Ausdruck mit Einzahlungsschein als Standardeinstellung
- im Rechnungs- bzw. Auftragsformular angezeigt haben möchte, kann
- dies persönlich für sich bei den Benutzereinstellungen
- konfigurieren:
Programm â Benutzereinstellungen â Druckoptionen
Standardvorlagenformat â OpenDocument/OASIS
Standardausgabekanal â Bildschirm
Standarddrucker â gewünschte Druckerbeschreibung auswählen
- (z.B. mit Einzahlungsschein Bank xy)
Anzahl Kopien â leer
speichern
2.13.1.4. Aufbau und nötige Anpassungen der Vorlagen
In der Vorlage sind als Modul "BESR" 4 Makros gespeichert, die
- aus dem von kivitendo erzeugten odt-Dokument die korrekte
- Referenznummer inklusive Prüfziffer sowie die Kodierzeile in
- OCRB-Schrift erzeugen und am richtigen Ort ins Dokument
- schreiben.
Für den Einzahlungsschein ist die letzte Seite des
- Dokuments reserviert
Direkt über dem Einzahlungsschein enthält die Vorlage eine
- Zeile mit folgenden Angaben (Bank-Konto-Identifikationsnummer und
- Postkonto-Nummer der Bank müssen gemäss Angaben der jeweiligen
- Bank angepasst werden):
DDDREF: 4 Werte zum Bilden der Referenznummer
- (jeweils durch einen Leerschlag getrennt):
erster Wert: Bank-Konto-Identifikation
- (nur Ziffern, maximal 6), muss
- angepasst werden.
zweiter Wert: <%customernumber%>
- (Kundennummer: nur Ziffern, maximal 6)
dritter Wert: <%ordnumber%>
- (Auftragsnummer bei Auftragsvorlage
- sales_oder_besr.odt, sonst 0) maximal 7 Ziffern,
- führende Buchstaben werden vom Makro entfernt
vierter Wert: <%invnumber%>
- (Rechnungsnummer bei Rechnungsvorlage
- invoice_besr.odt, sonst 0) maximal 7 Ziffern,
- führende Buchstaben werden vom Makro entfernt
-
DDDKONTO: Postkonto-Nummer der
- Bank, muss angepasst werden.
DDDBETRAG: <%total%> Einzahlungsbetrag oder 0,
- falls Einzahlungsschein ohne Betrag
DDDEND: muss am Ende der Zeile vorhanden sein
-
- Im Einzahlungsschein selbst müssen
- der Name und die Adresse der Bank, die Postkonto-Nummer der
- Bank, sowie der eigene Firmenname und die Firmenadresse
- angepasst werden. Dabei ist darauf zu achten, dass
- sich die Positionen der Postkonto-Nummern der Bank, sowie der
- Zeichenfolgen dddfr, DDDREF1, DDDREF2, 609, DDDKODIERZEILE nicht
- verschieben.
2.13.1.5. Auswahl der Druckvorlage in kivitendo beim Erzeugen einer
- odt-Rechnung (analog bei Auftrag)
Im Fussbereich der Rechnungsmaske muss neben Rechnung,
- OpenDocument/OASIS und Bildschirm die im Adminbereich erstellte
- Druckerbeschreibung ausgewählt werden, falls diese nicht bereits bei
- den Benutzereinstellungen als persönlicher Standard gewählt
- wurde.
2.13.1.6. Makroeinstellungen in LibreOffice anpassen
Falls beim Ãffnen einer von kivitendo erzeugten odt-Rechnung
- die Meldung kommt, dass Makros aus Sicherheitsgründen nicht
- ausgeführt werden, so müssen folgende Einstellungen in LibreOffice
- angepasst werden:
Extras â Optionen â Sicherheit â Makrosicherheit
Sicherheitslevel auf "Mittel" einstellen (Diese
- Einstellung muss auf jedem Computer durchgeführt werden, mit dem
- von kivitendo erzeugte odt-Rechnungen oder Aufträge geöffnet
- werden.)
Beim Ãffnen einer odt-Rechnung oder eines odt-Auftrags bei
- der entsprechenden Nachfrage "Makros ausführen"
- auswählen.
- Wichtig: die Makros sind
- so eingestellt, dass sie beim Ãffnen der Vorlagen selbst nicht
- ausgeführt werden. Das heisst für das Ansehen und Bearbeiten der
- Vorlagen sind keine speziellen Einstellungen in LibreOffice
- nötig.
+ kivitendo kann sowohl E-Mails direkt aus dem Programm heraus E-Mails
+ versenden, als auch in das Programm importiern. Damit dies
+ funktioniert, müssen die E-Mail-Parameter korrekt konfiguriert sein.
+ Dazu mehr in den folgenden Abschnitten.
+
2.13.1. E-Mail-Versand aus kivitendo heraus
Das Versenden von E-Mails kann zum Verschicken von Belegen genutzt
+ werden, z.B. um ein Angebot direkt an einen Kunden zu verschicken. Damit
+ dies funktioniert, muss eingestellt werden, über welchen Server die
+ E-Mails verschickt werden sollen. kivitendo unterstützt dabei zwei
+ Mechanismen: Versand über einen lokalen E-Mail-Server (z.B. mit
+ Postfix⢠oder Eximâ¢,
+ was auch die standardmäÃig aktive Methode ist) sowie Versand über einen
+ SMTP-Server (z.B. der des eigenen Internet-Providers).
Welche Methode und welcher Server verwendet werden, wird über die
+ Konfigurationsdatei config/kivitendo.conf
+ festgelegt. Dort befinden sich alle Einstellungen zu diesem Thema im
+ Abschnitt '[mail_delivery]'.
2.13.1.1. Versand über lokalen E-Mail-Server
Diese Methode bietet sich an, wenn auf dem Server, auf dem
+ kivitendo läuft, bereits ein funktionsfähiger E-Mail-Server wie z.B.
+ Postfixâ¢, Eximâ¢
+ oder Sendmail⢠läuft.
Um diese Methode auszuwählen, muss der Konfigurationsparameter
+ 'method = sendmail' gesetzt sein. Dies ist
+ gleichzeitig der Standardwert, falls er nicht verändert wird.
Um zu kontrollieren, wie das Programm zum Einliefern gestartet
+ wird, dient der Parameter 'sendmail = ...'. Der
+ Standardwert verweist auf das Programm
+ /usr/bin/sendmail, das bei allen oben genannten
+ E-Mail-Serverprodukten für diesen Zweck funktionieren sollte.
Die Konfiguration des E-Mail-Servers selber würde den Rahmen
+ dieses sprengen. Hierfür sei auf die Dokumentation des E-Mail-Servers
+ verwiesen.
2.13.1.2. Versand über einen SMTP-Server
Diese Methode bietet sich an, wenn kein lokaler E-Mail-Server
+ vorhanden ist oder einer vorhanden, dieser aber nicht konfiguriert
+ ist.
Um diese Methode auszuwählen, muss der Konfigurationsparameter
+ 'method = smtp' gesetzt sein. Die folgenden
+ Parameter dienen dabei der weiteren Konfiguration:
-
+
hostname
+ Name oder IP-Adresse des SMTP-Servers. Standardwert:
+ 'localhost'
-
+
port
+ Portnummer. Der Standardwert hängt von der verwendeten
+ Verschlüsselungsmethode ab. Gilt 'security =
+ none' oder 'security = tls', so ist
+ 25 die Standardportnummer. Für 'security =
+ ssl' ist 465 die Portnummer. Muss normalerweise nicht
+ geändert werden.
-
+
security
+ Wahl der zu verwendenden Verschlüsselung der Verbindung
+ mit dem Server. Standardwert ist 'none',
+ wodurch keine Verschlüsselung verwendet wird. Mit
+ 'tls' wird TLS-Verschlüsselung eingeschaltet,
+ und mit 'ssl' wird Verschlüsselung via SSL
+ eingeschaltet. Achtung: Für 'tls' und
+ 'ssl' werden zusätzliche Perl-Module benötigt
+ (siehe unten).
-
+
login und
+ password
+ Falls der E-Mail-Server eine Authentifizierung verlangt,
+ so können mit diesen zwei Parametern der Benutzername und das
+ Passwort angegeben werden. Wird Authentifizierung verwendet, so
+ sollte aus Sicherheitsgründen auch eine Form von Verschlüsselung
+ aktiviert werden.
2.13.2. Versendete E-Mails über IMAP exportieren
+ Es können versendete E-Mails über IMAP exportiert werden. Dazu muss
+ der entsprechende Server, auf dem die E-Mails abgelegt werden
+ sollen, konfiguriert werden. Dies geschieht in der Konfigurationsdatei
+ config/kivitendo.conf im Abschnitt
+ '[sent_emails_in_imap]'. Es können auch Server für
+ spezifische E-Mail-Adressen konfiguriert werden, indem der Abschnitt
+ kopiert wird und mit dem Namen
+ '[sent_emails_in_imap/email/EMAILADDRESS]', wobei
+ 'EMAILADDRESS' die entsprechenden E-Mail-Adresse
+ ist, versehen wird.
+
+ Die Reihenfolge für die Auswahl der Konfiguration ist wie folgt:
+
Falls es für die Absender-Adresse eine Konfiguration gibt nimm
+ diese.
Falls es es für die benutzerbezogene E-Mail-Adresse eine
+ Konfiguration gibt dann nimm diese.
Falls es eine generelle Konfiguration gibt dann nimm diese.
+
Die folgenden Parameter dienen der Konfiguration:
-
+
enabled
+
+ Falls 'enabled = 0' gesetzt ist, wird der
+ Export von E-Mails deaktiviert. Dies ist der Standardwert. Falls
+ 'enabled = 1' gesetzt ist, wird ist der
+ Export von E-Mails aktiviert.
+
-
+
hostname
+ Name oder IP-Adresse des IMAP-Servers. Standardwert:
+ 'localhost'
-
+
port
+
+ Portnummer. Der Standardwert hängt von der verwendeten
+ Verschlüsselungsmethode ab. Gilt 'ssl = 1',
+ so ist 993 die Standardportnummer. Für
+ 'ssl = 0' ist 143 die Portnummer. Muss
+ normalerweise nicht geändert werden.
+
-
+
ssl
+
+ Wahl ob eine Verschlüsselung bei der Verbindung mit dem Server
+ verwendet wird. Standardwert ist '1',
+ wodurch eine SSL-Verschlüsselung verwendet wird. Mit
+ '0' wird keine Verschlüsselung genutzt.
+
-
+
username und
+ password
+
+ Falls der IMAP-Server eine Authentifizierung verlangt, so können
+ mit diesen zwei Parametern der Nutzername und das Passwort
+ angegeben werden. Wird Authentifizierung verwendet, so sollte
+ aus Sicherheitsgründen auch Verschlüsselung aktiviert werden.
+
-
+
folder
+
+ Wahl des Ordners, in den kivitendo gesendete E-Mails
+ gespeichert. Standardwert ist
+ 'Sent/Kivitendo'. Ordnerhierarchien können
+ mit einem Slash ('/') getrennt werden.
+ Der gewählte Ordner muss existieren.
+
+ Bei einem Fehler bricht die Funktion ab und der Anwender bekommt die
+ Fehlermeldung, dass die E-Mail prinzipiell nicht verschickt werden
+ konnte. An dieser Stelle muss der kivitendo-Admin etwas genauer
+ prüfen, ob der Mail-Versand und/oder die Synchronisation den Fehler
+ verursacht hat. Ein Blick ins Email-Journal kann helfen den Fehler
+ einzuschränken.
+
2.13.3. E-Mails in kivitendo importieren
+ Um E-Mails in kivitendo zu importieren, muss der entsprechende
+ Server, von dem die E-Mails abgeholt werden sollen, konfiguriert
+ werden. Dies geschieht in der Konfigurationsdatei
+ config/kivitendo.conf im Abschnitt
+ '[imap_client]'.
+
Die folgenden Parameter dienen der Konfiguration:
-
+
enabled
+
+ Falls 'enabled = 0' gesetzt ist, wird der
+ Import von E-Mails deaktiviert. Dies ist der Standardwert. Falls
+ 'enabled = 1' gesetzt ist, wird ist der
+ Import von E-Mails aktiviert.
+
-
+
hostname
+ Name oder IP-Adresse des IMAP-Servers. Standardwert:
+ 'localhost'
-
+
port
+
+ Portnummer. Der Standardwert hängt von der verwendeten
+ Verschlüsselungsmethode ab. Gilt 'ssl = 1',
+ so ist 993 die Standardportnummer. Für
+ 'ssl = 0' ist 143 die Portnummer. Muss
+ normalerweise nicht geändert werden.
+
-
+
ssl
+
+ Wahl, ob eine Verschlüsselung bei der Verbindung mit dem Server
+ verwendendet wird. Standardwert ist '1',
+ wodurch eine SSL-Verschlüsselung verwendet wird. Mit
+ '0' wird keine Verschlüsselung genutzt.
+
-
+
username und
+ password
+
+ Falls der IMAP-Server eine Authentifizierung verlangt, so können
+ mit diesen zwei Parametern der Nutzername und das Passwort
+ angegeben werden. Wird Authentifizierung verwendet, so sollte
+ aus Sicherheitsgründen auch Verschlüsselung aktiviert werden.
+
-
+
base_folder
+
+ Wahl des Ordners, den kivitendo als Basis für das Erstellen von
+ Unterordnern und das Abholen von E-Mails verwendet. Standardwert
+ ist 'INBOX'. Ordnerhierarchien können mit
+ einem Slash ('/') getrennt werden. Beispiel:
+ 'INBOX/kivitendo'. In diesem Ordner dürfen
+ keine Unterordner existieren und keine manuell angelegt werden.
+
+ Wenn eingeschaltet, wird beim Anlegen von Verkaufsangeboten und
+ -aufträgen ein Unterordner im E-Mail-Client für den entsprechenden
+ Beleg angelegt. E-Mails, in diesen Ordner werden automatisch beim
+ Ãffnen des Belegs in kivitendo importiert. Um die E-Mails übersichtlich
+ zu halten, kann der Hintergrund-Job
+ 'CleanUpEmailSubfolders' genutzt werden. Dieser
+ importiert alle E-Mails und löscht alle Unterordnern, die nicht zu
+ einem offenen Beleg gehören. Importierte E-Mails werden nicht
+ gelöscht; erst beim Löschen des Unterordners werden sie gelöscht.
+
+ Es können auch E-Mails in kivitendo importiert werden, die nicht zu
+ einem Beleg gehören. Dafür kann der Hintergrund-Job
+ 'SyncEmailFolder' verwendet werden. Dieser
+ synchronisiert standartmäÃig den Ordner der in
+ 'base_folder' angegeben ist. Dies kann mit dem
+ Job-Parameter 'folder' geändert. Die Importierten
+ E-Mails werden im E-Mail-Journal gespeichert.
+
+ Beim Umzug des E-Mail-Servers kann kivitendo schon
+ importierte E-Mails nicht mehr erkennen. Dies führt dazu, dass alle
+ E-Mails erneut importiert werden.
+
