mirror of
https://github.com/OpenXE-org/OpenXE.git
synced 2024-12-25 14:10:28 +01:00
1 line
12 KiB
Plaintext
1 line
12 KiB
Plaintext
<strong><span style="font-size:28px;">Smarty</span></strong><h1>Features</h1>Mit Hilfe der integrierten Template-Engine Smarty können einfach und flexibel zeichenbasierte Ausgabestrukturen von Datenformaten wie CSV, XML oder JSON an die Bedürfnisse des Kunden angepasst werden. Im Grunde muss lediglich das vorhandene Zielformat in eine Textdatei kopiert und mit den entsprechenden Variablen gefüllt werden. Diese können dabei noch umformatiert werden.<br />Belegdaten finden sich z.B. in der Smarty-Variable $beleg und werden in gewohnter PHP-Objektschreibweise angesprochen, z.B. $beleg->kundennummer oder $beleg->belegnr. Die Namensgebung gleicht der Benennung von Datenbank-Spaltennamen. Auch ein Zugriff auf komplexere Strukturen ist möglich (je nach Beleg). So kann im Lieferschein auf den zu Grunde liegenden Auftrag zugegriffen werden: $beleg->auftrag->lieferdatum.Verkürztes Beispiel mit fiktivem Format<p> {* Beleg-Stammdaten -------------------------------- *}<br />{$beleg->status}<br />{$beleg->datum|date_format:'%d.%m.%Y'}<br />{$beleg->belegnr}<br />{$beleg->kundennummer}<br />{$beleg->name}<br />{* Zugriff auf Daten des zugrundeliegenden Auftrages *}<br />{$beleg->auftrag->lieferdatum}<br />{* Weitere Felder entfernt *}</p><p>{* Positionen - Beginn ------------------------------ *}<br /> {* Schleife durchläuft alle verfügbaren Positionen *}<br /> {foreach from=$beleg->positionen key=keypos item=position}<br /> {$position->nummer}<br /> {$position->bezeichnung}<br /> {$position->beschreibung}<br /> {$position->menge}<br /> {$position->preis}<br /> {* Weitere Felder entfernt *} <br /> {/foreach}<br />{* Positionen - Ende -------------------------------- *}</p><h1>Datenmanipulation und Strukturen</h1><h2>Formatumwandlung</h2> Datumswerte können nach Anforderung ausgegeben werden:<ul><li>Int. Datumsformat (ISO 8601): {$beleg->datum|date_format:'%Y-%m-%d'}</li><li>Deutsches Datumsformat (DIN 5008): {$beleg->datum|date_format:'%d.%m.%Y'}</li></ul>Zahlen können nach Bedarf umformatiert werden. Hier am Beispiel der Spalte "Menge":<ul><li>Ausgabe ohne Nachkommastellen (als Ganzzahl): {$position->menge|string_format:'%d'}</li><li>Ausgabe mit einer Nachkommastelle: {$position->menge|string_format:'%.1f'}</li><li>Ausgabe mit zwei Nachkommastellen: {$position->menge|string_format:'%.2f'}</li></ul>Grundsätzlich können alle Formate ausgegeben werden, die durch die Funktion <a href="https://www.php.net/manual/de/function.sprintf.php" target="_blank">sprintf in PHP</a> verfügbar sind.<h2>Anrufen komplexerer Strukturen</h2><h3>ArtikelStammdaten aus Positionen anprechen</h3><p>Über die Belegpositionen können auch "darunterliegende" Strukturen abgerufen werden, die nicht direkt im Beleg gespeichert sind. Ein Beispiel dafür ist das Gewicht eines Artikels. Dieses kann über {$position->articledata->gewicht} abgerufen werden. So kann, z.B. durch eine Multiplikation mit der Menge der Position und dem Aufaddieren aller Gewichte, auch das Gesamtgewicht aller Artikel eines Beleges berechnet und übertragen werden.<br />Über $position->articledata können alle Spalten aus der Tabelle artikel angesprichen werden. Dabei sollte immmer beachtet werden ob Informationen aus den Artikel-Stammdaten evtl. in der Auftragsposition beereirts verändert worden sein könnten. Im Zweifelsfall sollte der Wert aus dem Beleg verwendet werden.</p><h1>Beispiele</h1> Im Folgenden haben wir Ihnen einige Beispiele zusammengefasst, die die Ausgabe verschiedener Lieferscheinformate in den Formaten EDI, CSV und XML ermöglichen. Bitte prüfen Sie bei eigener Anwendung die Spaltenbeschriftungen (CSV), Tagnamen (XML) und EDI-Spezifikationen. Natürlich sind auch weiteere Ausgabeformate (wie z.B. JSON) denkbar.<h2>Beispiel Lieferschein CSV (ausführlich)</h2> Das folgende Beispiel listet ein ausführliches Beispiel für einen Export eines Lieferscheines in verschiedenen Formaten.<h3>Format EDI</h3>- wird ergänzt -<h3>Format CSV</h3>"tracking";"beleg_status";"beleg_datum";"beleg_lieferdatum";"beleg_tatsaechlicheslieferdatum";"beleg_versandart";"beleg_zahlungsweise";"beleg_belegnr";"beleg_hauptbelegnr";"beleg_kundennummer";"beleg_name";"beleg_abteilung";"beleg_unterabteilung";"beleg_adresszusatz";"beleg_ansprechpartner";"beleg_telefon";"beleg_email";"beleg_land";"beleg_strasse";"beleg_plz";"beleg_ort";"beleg_projekt";"beleg_aktion";"beleg_internebemerkung";"beleg_internebezeichnung";"beleg_freitext";"beleg_ihrebestellnummer";"beleg_lieferbedingung";"beleg_art";"artikel_nummer";"artikel_bezeichnung";"artikel_beschreibung";"artikel_menge";"artikel_preis";"artikel_rabatt";"artikel_waehrung";"artikel_lieferdatum";"artikel_sort";"artikel_umsatzsteuer";"artikel_einheit";"artikel_zolltarifnummer";"artikel_herkunftsland";"artikel_artikelnummerkunde";"wunschlieferdatum";"artikel_freifeld1";"artikel_freifeld2";"artikel_freifeld3";"artikel_freifeld40"{foreach from=$beleg->positionen key=keyrow item=position}{* Positionen *}\"{$position->tracking}";\"{$beleg->status}";\"{$beleg->datum|date_format:'%d.%m.%Y'}";\"{$beleg->lieferdatum}";\"{$beleg->tatsaechlicheslieferdatum}";\"{$beleg->versandart}";\"{$beleg->zahlungsweise}";\"{$beleg->belegnr}";\"{$beleg->hauptbelegnr}";\"{$beleg->kundennummer}";\"{$beleg->name}";\"{$beleg->abteilung}";\"{$beleg->unterabteilung}";\"{$beleg->adresszusatz}";\"{$beleg->ansprechpartner}";\"{$beleg->telefon}";\"{$beleg->email}";\"{$beleg->land}";\"{$beleg->strasse}";\"{$beleg->plz}";\"{$beleg->ort}";\"{$beleg->projekt}";\"{$beleg->aktion}";\"{$beleg->internebemerkung}";\"{$beleg->internebezeichnung}";\"{$beleg->freitext}";\"{$beleg->ihrebestellnummer}";\"{$beleg->lieferbedingung}";\"{$beleg->art}";\"{$position->nummer}";\"{$position->bezeichnung}";\"{$position->beschreibung}";\"{$position->menge|string_format:'%.2f'}";\"{$position->preis}";\"{$position->rabatt}";\"{$position->waehrung}";\"{$position->lieferdatum}";\"{$position->sort}";\"{$position->umsatzsteuer}";\"{$position->einheit}";\"{$position->zolltarifnummer}";\"{$position->herkunftsland}";\"{$position->artikelnummerkunde}";\"{$beleg->auftrag->lieferdatum}";\"{$position->freifeld1}";\"{$position->freifeld2}";\"{$position->freifeld3}";\{* Ggf. weitere Freifelder *}";\"{$position->freifeld40}";\<br />{/foreach}<h2>Format XML</h2><p>{$beleg->status}<br />{$beleg->datum|date_format:'%d.%m.%Y'}<br />{$beleg->lieferdatum}<br />{$beleg->tatsaechlicheslieferdatum}<br />{$beleg->versandart}<br />{$beleg->zahlungsweise}<br />{$beleg->belegnr}<br />{$beleg->hauptbelegnr}<br />{$beleg->kundennummer}<br />{$beleg->name}<br />{$beleg->abteilung}<br />{$beleg->unterabteilung}<br />{$beleg->adresszusatz}<br />{$beleg->ansprechpartner}<br />{$beleg->telefon}<br />{$beleg->email}<br />{$beleg->land}<br />{$beleg->strasse}<br />{$beleg->plz}<br />{$beleg->ort}<br />{$beleg->projekt}<br />{$beleg->aktion}<br />{$beleg->internebemerkung}<br />{$beleg->internebezeichnung}<br />{$beleg->freitext}<br />{$beleg->ihrebestellnummer}<br />{$beleg->lieferbedingung}<br />{$beleg->art}<br />{foreach from=$beleg->positionen key=keypos item=position}<br /> {$position->nummer}<br /> {$position->bezeichnung}<br /> {$position->beschreibung}<br /> {$position->menge}<br /> {$position->preis}<br /> {$position->rabatt}<br /> {$position->waehrung}<br /> {$position->lieferdatum}<br /> {$position->sort}<br /> {$position->umsatzsteuer}<br /> {$position->einheit}<br /> {$position->zolltarifnummer}<br /> {$position->herkunftsland}<br /> {$position->artikelnummerkunde}<br /> {$position->freifeld1}<br /> {$position->freifeld2}<br /> {$position->freifeld3}<br /> {* Ggf. weitere Freifelder *}<br /> {$position->freifeld40}<br />{/foreach}<br />{if $beleg->versand}<br />{foreach from=$beleg->versand key=keyversand item=tracking} {* Versand *}<br /> {$tracking->tracking}<br />{/foreach}<br />{/if}</p><h2>Beispiel Lieferschein mit MHD</h2> Im Folgenden werden Beispiele als Ergänzung zu obigen Code-Beispielen gezeigt, die nur die Besonderheiten in Bezug auf MHDs in einer Position berücksichtigen.<h3>Format CSV</h3>- wird ergänzt -<h3>Format XML</h3>- wird ergänzt -<br /> <h2>Beispiel Lieferschein mit Charge</h2> Im Folgenden werden Beispiele als Ergänzung zu obigen Code-Beispielen gezeigt, die nur die Besonderheiten in Bezug auf Chargen in einer Position berücksichtigen.<h3>Format CSV</h3>- wird ergänzt -<h3>Format XML</h3>- wird ergänzt -<br /> <h2>Beispiel Lieferschein mit Charge und MHD</h2> Im Folgenden werden Beispiele als Ergänzung zu obigen Code-Beispielen gezeigt, die nur die Besonderheiten in Bezug auf MHDs und Chargen in einer Position berücksichtigen.<h3>Format CSV</h3>- wird ergänzt -<h3>Format XML</h3>- wird ergänzt -<br /> <h2>Beispiel Auftrag</h2> Anwendbar nur bei direktem Fulfillment ohne Autoversand. Diese Option sollte genau geprüft werden, meistens ist die Übertragung von Lieferscheinen der optimale Weg.<h3>Format EDI</h3>- wird ergänzt -<h3>Format CSV</h3>- wird ergänzt -<h3>Format XML</h3>- wird ergänzt -<h2>Eingehende Datenkonvertierung</h2><h3>Es stehen folgende Objekte zur Verfügung</h3>$csv ein Array aus Objekten mit dem Headerspalten als Keys<br />$xml ein Object das aus einem Xml gaparst wurde<br />$object ist ein $xml falls Ursprungsdaten ein gültiges xml waren, sonst das $csv Objekt<br />$original ist der Original-String des Eingangs<h3>Operationen</h3>{"Der Auftrag enthält keine Positionen"|error}<br />gibt einen Fehler an Smarty aus das in den Übertragungsmonitor geloggt wird<br /><br />{"SELECT nummer FROM artikel"|assignsql assign="artikelnummern"}<br />speichert das Ergebnis der Sqlabrfage in die Variable $artikelnummern<br /><br />{$original|replace:"1.0":"2.0"|getxml assign="neuesxml"}<br />Ersetzt alle Strings 1.0 zu 2.0 und speichert wandelt es in ein neues Objekt $neuesxml um<br /><br />{$position->nummer|pregreplace:'/[^0-9]/':''}<br />füht eine Requläre Ersätzung auf das ein Objekt aus<br /> |