PEIQ Knowledge Base
[0-15] OUTBOUND Online-Export CREATE-Artikel
Transportverfahren | sFTP (Abruf/Abräumen aus der PEIQ Cloud durch Dritte) |
|---|---|
Objekt | XML, JPG |
Trigger | manuell |
Unterstützte Drittsysteme | z. B. huGO |
Beispieldaten | siehe untenstehend |
Mit dem vorliegenden Export von CREATE-Artikeln inklusive der zugehörigen Bilder werden diese zur Abholung durch Dritte in der PEIQ Cloud im sFTP-Bereich (sftp://data.peiq.cloud/…) zur Verfügung gestellt.
Funktionalitäten des Exports von Ausgaben mit Seiten, Artikeln und Bildern
Export von CREATE-Artikeln und -Bildern
Übertragung via sFTP
Inhaltsverzeichnis
Aufbereitung und Übertragung der Daten
Für den Export von CREATE-Artikeln und deren Bilder werden XML-Files und Bilder über die hier vorliegende Standard-Schnittstelle auf eine Destination im sFTP-Bereich (sftp://data.peiq.cloud/…) in der PEIQ Cloud exportiert. Diese Daten können von Dritten übernommen bzw. abgeräumt werden.
Der Trigger für den Export der Daten ist gekoppelt an den Kanal-Status “Online” der Artikel-Ausprägung und wird manuell durch das Publizieren des Kanals in CREATE ausgelöst.
Generierung Artikel-XML
Beim Publizieren des Online-Kanals einer Ausprägung wird automatisch ein XML-File geschrieben. Dabei finden zunächst Standard-Transformationen der Inhaltselemente statt, bevor anschließend noch einmal (kundenspezifische) Stylesheets weitere Anpassungen vornehmen.
Das fertige Artikel-XML enthält die relevanten Inhaltselemente, deren Formatierungen sowie die Metadaten der Ausprägung und der Bilder.
Übertragung der Daten
Für jeden publizierten Online-Kanal einer Artikel-Ausprägung wird jeweils eine XML-Datei erzeugt und auf den PEIQ sFTP gelegt.
Sind im CREATE-Artikel Bilder oder Bildergalerie(n) referenziert, werden die zugehörigen Bilder ebenfalls als JPG-Datei mitgeliefert.
Bei einer Aktualisierung werden erneut die geänderten Artikel-XMLs (inkl. Bilder) übertragen. Dies kann beliebig oft erfolgen.
Beim Depublizieren eines Online-Kanals wird ebenfalls ein Artikel-XML geschrieben und exportiert. Diese beinhaltet allerdings lediglich die Änderung des Kanalstatus von “Online” zu “Offline”. So kann das Fremd-System erkennen, dass der Kanal der Ausprägung in CREATE Offline genommen wurde.
Der Zeitpunkt der Übertragung auf den sFTP wird als Timestamp im Dateinamen des XML bzw. der Bilddateien gespeichert.
Aufruf (manueller Trigger)
Standardmäßig wird die Übertragung der Daten manuell durch das Stufen des Online-Kanals in CREATE veranlasst, sobald ein Kanal den OnlineStatus “Online” erhält, was durch das Klicken des Publizieren-Buttons in der Kanalsteuerung ausgelöst wird.
Content
Die Strukturen der Inhalte und die entsprechende Wandlung in HTML-Tags werden von PEIQ als Standards festgelegt und in einem separaten Dokument aufgelistet. Sollten neue Tags benötigt werden, muss PEIQ diese zunächst prüfen und festlegen, ob sie in den Standard aufgenommen werden.
Bildbereiche/Geometrie
In CREATE gibt es keine eigenständigen Bildbereiche. An den Bildern können allerdings Bildschwerbereiche festgelegt werden. Der Bildschwerbereich ist als Rechteck auf dem Bild definiert. Die linke obere Ecke des Rechtecks sowie Breite und Höhe (Koordinaten x, y bzw. w, h) werden als Attribute des Bilds im article-XML übertragen. Die Bildbereiche werden in ihrem Breiten-Höhen-Verhältnis also so angepasst, dass der Bildexport die im CMS verwendeten Breiten-Höhen-Verhältnis annähernd widerspiegelt.
Übertragungsart: sFTP
Der Export der Daten erfolgt auf eine Destination im sFTP-Bereich (sftp://data.peiq.cloud/…) in der PEIQ Cloud. Diese Daten sind dann von dem/der Abnehmer:in (Dritten) “abzuräumen”.
Namenskonvention
Die Dateien werden immer mit einem Timestamp übergeben. Anhand dessen kann der zuletzt exportierte Datensatz identifiziert werden.
Timestamp
Der Timestamp ist folgendermaßen aufgebaut:
Monat (2-stellig), Tag (2-stellig), Stunde (2-stellig), Minute (2-stellig), Sekunde (2-stellig), Millisekunde (3-stellig)
Beispiel: "0512174535345"
XML
article_<ID>_<timestamp>.xml
Bild
image_<ID>_<timestamp>.jpg
Übertragung der Metadaten
Die Metadaten der Artikel-Ausprägungen und Bilder werden in den Artikel-XMLs gespeichert und mitgeschickt.
Besondere Tags im Artikel-XML
Fett
Gefettete Texte werden beim Online-Export in den Elementen, in denen sie gemäß TextSchema in CREATE erlaubt sind, im Tag <strong></strong> übertragen.
Kursiv
Kursive Texte werden in den Elementen, in denen sie gemäß TextSchema in CREATE erlaubt sind, im Tag <em></em> übertragen.
Bilder
Inline-Bilder werden immer in der nachfolgenden Struktur inkl. der Metadaten übertragen:
<ImageSection type="Image">
<Image>
<Filename>image_<id>_<timestamp>.jpg</Filename>
<Area x="0" y="0" w="1000" h="1000"/>
<Title>Bildunterschrift</Title>
<Source>Foto: Inhaber Bildrechte</Source>
<SHA1><eindeutiger Hashwert></SHA1>
</Image>
</ImageSection>Bildergalerie
Inline-Bildergalerien werden immer in der nachfolgenden Struktur inkl. der Metadaten übertragen:
<ImageSection type="Gallery">
<Image>
<Filename>image_<id><timestamp>.jpg</Filename>
<Area x="0" y="0" w="1000" h="1000"/>
<Title>Bildunterschrift</Title>
<Source>Foto: Inhaber Bildrechte</Source>
<SHA1><eindeutiger Hashwert></SHA1>
</Image>
<Image>
<Filename>image<id><timestamp>.jpg</Filename>
<Area x="0" y="0" w="1000" h="1000"/>
<Title>Bildunterschrift</Title>
<Source>Foto: Inhaber Bildrechte</Source>
<SHA1><eindeutiger Hashwert></SHA1>
</Image>
<image>
...
</image>
...
</ImageSection>Aufmacherbild
Inline-Bilder werden immer in der nachfolgenden Struktur inkl. der Metadaten übertragen:
<ImageSection type="Lead">
<Image>
<Filename>image_<id>_<timestamp>.jpg</Filename>
<Area x="0" y="0" w="1000" h="1000"/>
<Title>Bildunterschrift</Title>
<Source>Foto: Inhaber Bildrechte</Source>
<SHA1><eindeutiger Hashwert></SHA1>
</Image>
</ImageSection>Teaserbild
Inline-Bilder werden immer in der nachfolgenden Struktur inkl. der Metadaten übertragen:
Autorenprofil und Autor frei
Da die Tag-Struktur für “Autorenprofil” und “Autor frei” gleich ist, kann im Export-XML - sofern beides im Artikel verwendet wird - nicht unterschieden werden, was das Profil und was der Autor ist. Das neue Element “Autor frei” wird somit in der Standard XML-Schnittstelle im bestehenden Tag “Author” übergeben:
<Author><Email/><Name>AlexS</Name></Author> → Autor frei
...
<Author><Email>peter.lustiger@web.de</Email><Name>Peter Lustiger</Name></Author> → Autorenprofil
Ortsangabe
Die Ortsangabe wird im Tag <Location></Location> übertragen.
Quelle
Die Quelle wird im XML als <Source></Source> übertragen.
Zitat
Zitate werden im Tag <Quote></Quote> in folgender Struktur übertragen:
Aufzählung
Aufzählungen werden im Tag <List></List> in folgender Struktur übertragen:
Frage & Antwort
Die Elemente Interview-Frage und das darauf folgende Element Interview-Antwort werden folgendermaßen übertragen:
Embeds
Embeds werden im Tag <Embed></Embed> in folgender Struktur übertragen:
Infobox
Der Inhalt der CREATE-Infobox wird innerhalb des Textes an der entsprechenden Stelle in das Tag <SubArticle type="Infobox"></SubArticle> geschrieben. Die XML-Struktur innerhalb von <SubArticle> ist genauso, wie innerhalb von <Text>.
Für Unterartikel (Infoboxen) wird dasselbe XSLT-Stylesheet wie beim Hauptartikel angewendet.
Das XML-Schema Create.ArtikelExport wurde so angepasst, dass das Tag <SubArticle> erlaubt ist.
Onlinebox
Die Übertragung der CREATE-Onlinebox erfolgt analog zur CREATE-Infobox. Somit wird der Inhalt der CREATE-Onlinebox innerhalb des Textes an der entsprechenden Stelle in das Tag <SubArticle type="Onlinebox"></SubArticle> geschrieben.
Übertragung der Werte für Online-Ressorts
Über die Eigenschaft DMappeDigitalNameExtern (siehe https://peiq.atlassian.net/wiki/spaces/PPSD/pages/993624101/Rubrikenbaum#NameExtern-(DMappeDigitalNameExtern)) an den Pfadmappen im https://peiq.atlassian.net/wiki/spaces/CORE/pages/991166570 des jeweiligen Kanals (hier: Online) kann definiert werden, welcher Wert für das Online-Ressort beim Online-Export übertragen werden soll:
Wenn die Eigenschaft befüllt ist, so gilt diese an der Schnittstelle. Ist die Eigenschaft leer, dann gilt wie bisher die Eigenschaft DMappeDigitalName für die Schnittstelle.
Aktualisieren von exportierten Online-Ausprägungen / -Versionen
Beim Exportieren eines Online-Kanals einer digitalen Ausprägung entsteht eine Version im jeweiligen Zielsystem (analog Print). Diese kann auch nachträglich noch aktualisiert werden, wenn die Version im Zielkanal nicht für Aktualisierungen gesperrt ist. Änderungen im Zielsystem werden nicht nach CREATE zurück geschrieben.
Validierung der Tagstruktur mittels XSD-File
Damit externe CMS-Systeme (Content-Management-Systeme) die XML-Daten, die über die Schnittstelle geliefert werden, vor dem Import aus CREATE auf Korrektheit prüfen können, kann die XML-Struktur der Export-Files gegen ein XML-Schema (.xsd-File) Create.ArtikelExport geprüft werden. So kann das Fremd-System sicherstellen, dass Export- und Import-Seite stets abgestimmt und versioniert auf demselben Level unterwegs sind.
Beim Einsatz des Online-Exports wird das .xsd-File wird Kund:innen regelmäßig (bei Änderungen) zur Verfügung gestellt.
Beispiel eines Artikel-XML
Mitwirkungspflichten der Kund:innen
XML-Validierung mittels .xsd-Datei im Online-CMS einrichten.
Maßgebliche DB-Tabellen
DText, DBild.
DLLs
Aktuelle CMSExternDPS
Aktuelle NGenWebServices.dll
Verwandte Seiten
Nur für PEIQ-Mitarbeiter: