User Tools

Site Tools


offer-cube:howto:pdf-special-variables

offer-cube / PDF Power-User Funktionen: Variablen und Funktionen

Allgemeines / Zusammenfassung

Die PDF Erweiterungen für Power-User ermöglichen folgende Funktionalitäten (link auf die entsprechenden Dokumente):

Hier in diesem Dokument werden speziell folgende Funktionalitäten erläutert:

Gesteuert werden diese Funktionen über Funktionsaufrufe, die zwischen jeweils 2 eckigen Klammern aufgerufen werden. Hier gibt es die Möglichkeit Daten von Objekten (z.B: Gesamtpreis, Rechnungsdatum, Angebotsnummer, etc.) aus dem System zu holen und über Variablen einzufügen. Oder es gibt eine Funktion um Bilder-Attachments zu holen und als Bilder in das PDF einzufügen.

Diese Erweiterungen lassen sich auf folgende Objekte/Felder anwenden:

  • Angebote/Aufträge/Rechnungen: Felder “Überschrift/Titel”, “… Beschreibung”, “… Appendix”
  • Position: Felder “Positions-Bezeichnung”, “Positions-Beschreibung”
  • Artikel: Feld “Beschreibung”

Variablen/Funktionen lassen sich größtenteils wie in der Dokumentation der Template Engine smarty http://www.smarty.net/docs/en/ verwenden.

Details: vorhandene Variablen

Einige Variablen stehen grundsätzlich zur Verfügung.

Siehe Variablen Übersicht

Hierzu gehören unter anderem:

Details: Variablen ausgeben

Die Variablen lassen sich größtenteils in der von smarty bekannten Syntax ausgeben bzw. verwenden - siehe http://www.smarty.net/docs/en/language.syntax.variables.tpl

ACHTUNG:
Entgegen der Angabe in der smarty Dokumentation werden Variablen und Funktionen mit 2 eckigen Klammern aufgerufen.

Also z.B. Aufruf einer Funktion [[funktion parameter="wert"]] ODER Ausgabe einer Variable [[$variable]]

Beispiel: Verwendung des Firmennamens als Variable

Vielen Dank für Ihren Auftrag, 
Ihr [[$CONFIGURATION.ownCompany]] Team

Verwendung der $CONFIGURATION Variablen

Anwendungsbeispiel: Verwendung der Rechnungsnummer und des Preises einer Rechnung

Für die Zahlungsanweisung an den Kunden kann z.B. in der Bankverbindung (Einstellungen → Eigene Firmendaten → Bankverbindung) nochmals auf den Gesamtpreis und die Rechnungsnummer als Verwendungszweck verwiesen werden.

Das aktuelle Objekt ist über die Variable [[$obj.<fieldname>]] zugreifbar.

Beispiel: Bankverbindung mit Verwendungszweck Angabe:

Bitte überweisen Sie den offenen Rechnungsbetrag von <b>[[$obj.price_wtax|d2bcurrency]]</b> auf unser Konto und geben Sie als Verwendungszweck die Rechnungsnummer <b>[[$obj._ref]]</b> an.

Verwendung des aktuellen Objekts mit [[$obj]]

In diesem Beispiel wird auch die Schriftstil-Formatierung mit <b> verwendet.

Zusätzlich kommt ein Modifikator d2bcurrency zur Verwendung, der eine Zahl als Euro Betrag mit Tausendertrennzeichen und Komma formatiert.

Details: Holen eines Objekts mit [[getobject]]

Die Funktion [[getobject]] erlaubt das Holen von Daten eines Objekts aus der Datenbank.
Ein Objekt kann hierbei ein Angebot/Auftrag/Rechnung sein, aber auch andere Objekte wie resource oder article.

Beispiel: Holen einer resource mit Namen und Verwendung der Beschreibung description:

Ihr Projektleiter: [[getobject module="resource" by="name" name="Leo Eibler" assign="projectmgr"]]
[[$projectmgr.description|nl2br]]

Verwendung der Funktion [[getobject]]

Details: Variablen Übersicht

Eine Übersicht der gängigsten Variablen:

$CONFIGURATION Die systemweite Konfigurations-Variable $CONFIGURATION ist ein assoziatives Array mit Systemeinstellungen, Standardtexten, etc.
$obj Das aktuelle Objekt (Angebot, Auftrag, Rechnung) als assoziatives Array

Beispiele:

$CONFIGURATION.ownCompany Eigener Firmenname: EinstellungEigene Firmendaten
$CONFIGURATION.ownAddress Eigene Firmen Adresse (mit Newlines): EinstellungEigene Firmendaten
$CONFIGURATION.ownTelephone Eigene Firmen Telefon Nummer: EinstellungEigene Firmendaten
$CONFIGURATION.ownFax Eigene Firmen Fax Nummer: EinstellungEigene Firmendaten
$CONFIGURATION.ownMail Eigene Firmen Mailadresse: EinstellungEigene Firmendaten
$CONFIGURATION.ownWeb Eigene Firmen Internetseite: EinstellungEigene Firmendaten
$CONFIGURATION.ownUID Eigene Umsatzsteuer ID: EinstellungEigene Firmendaten
$CONFIGURATION.useInvoicePdfOwnBankAccountHeadline Überschrift Rechnung Bankverbindung: EinstellungDruck Standard Texte
$CONFIGURATION.ownBankAccount Eigene Bankverbindung: EinstellungDruck Standard Texte
$CONFIGURATION.useInvoicePdfOwnBankAccountHeadline_EN Überschrift Rechnung Bankverbindung (Englisch): EinstellungDruck Standard Texte
$CONFIGURATION.ownBankAccount_EN Eigene Bankverbindung (Englisch): EinstellungDruck Standard Texte
$obj._ref Aktuelles Nummer des Objekts - z.B. bei Angebot Angebotsnr. o1234, bei Auftrag Auftragsnr n1234 oder bei Rechnung Rechnungsnr r1234
$obj.price Ursprungspreis netto ohne Mehrwertsteuer.
$obj.price_wdiscount Rabattierter Preis netto ohne Mehrwertsteuer.
$obj.price_wtax End-Preis mit Mehrwertsteuer. Kann mit Tausendertrennzeichen und 2 Nachkommastellen formatiert werden mit [[$obj.price_wtax|d2bCurrency]]
$obj.tax_portion_a Mehrwertsteuer für Satz-A (mit _b für Satz-B usw)
$obj.summary Überschrift
$obj.description Beschreibung
$obj.appendix Appendix
$obj.startdate Start Datum als Unix-Timestamp. Kann zu lesbaren Datum formatiert werden mit [[$obj.startdate|ut2humandate]]
$obj.enddate End Datum als Unix-Timestamp. Kann zu lesbaren Datum formatiert werden mit [[$obj.enddate|ut2humandate]]
$obj.invoice_dt Nur bei Rechnung: Rechnungsdatum als Unix-Timestamp. Kann zu lesbaren Datum formatiert werden mit [[$obj.invoice_dt|ut2humandate]]
$obj.duepayment_dt Nur bei Rechnung: Zahlungsziel als Unix-Timestamp. Kann zu lesbaren Datum formatiert werden mit [[$obj.duepayment_dt|ut2humandate]]

Eine Übersicht der gängigsten Modifikatoren:

d2bCurrency Formatierung von Euro Beträgen mit Tausenderpunkt und Kommazeichen - z.B.
[[$obj.price_wtax|d2bCurrency]]
nl2br Sorgt für einen Zeilenumbruch im PDF, falls die Eingabevariable einen Zeilumbruch beinhaltet - z.B.
[[$projectmgr.description|nl2br]]

Die Variablen sind immer in [[ und ]] einzufassen.
Also z.B. um den eigenen Firmennamen zu verwenden: [[$CONFIGURATION.ownCompany]]

Die Variablen werden in PDFs (z.B. bei der Angebotsbeschreibung, Auftragsbeschreibung, Rechnungsbeschreibung, Annex, etc.) als auch bei den Email Zusatz-Texten ausgewertet.

Siehe auch Email zusätzlicher Text und Anhänge.

offer-cube/howto/pdf-special-variables.txt · Last modified: 2018/07/22 14:51 (external edit)