PEIQ Knowledge Base
[1-14-1] OUTBOUND PMG Ausgaben mit Seiten, Artikel und Bilder (Content-Syndication und E-Paper)
übergeordnete ID | [1-14] OUTBOUND Ausgaben mit Seiten, Artikel und Bilder (Content-Syndication und E-Paper) |
---|---|
Transportverfahren | sFTP (Abruf/Abräumen aus der PEIQ Cloud durch Dritte) |
Objekt | Je Ausgabe in einer Zip-Datei: Ausgabe-XML, Ganzseiten-PDFs, Bilder |
Trigger | Automatisch |
Typische Drittsysteme | PMG |
Mit dem vorliegenden Export von Ausgaben, Seiten, Artikel sowie Bildern 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, Artikel und Bilder
Export von Zip-Dateien, die jeweils ein Ausgabe-XML mit zugehörigen Ganzseiten-PDFs und Bildern enthält (keine Übertragung von Updates)
Übertragung via sFTP
Inhaltsverzeichnis
Aufbereitung und Übertragung der Daten
Für den Export von Ausgaben und deren Seiten, Artikel sowie Bilder werden über die hier vorliegende Standard-Schnittstelle Daten 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 einen Export ist zeitlich gesteuert.
E-Paper-Produkt
Beim Fertigstufen der Seiten eines redaktionellen Druckprodukts wird automatisch ein “E-Paper-Produkt” angelegt bzw. aktualisiert.
Dieses E-Paper-Produkt enthält die Artikel und dient als Grundlage für den Export. Hierüber können in der GUI (Graphical User Interface) die Daten vor dem Export noch einmal betrachtet werden.
Übertragung der Daten
Für jedes dieser E-Paper-Produkte wird ein ZIP-File übertragen, das ein XML der Ausgabe enthält, sowie die zugehörigen Bilddateien und Ganzseiten-PDFs. Das XML enthält die Artikelinhalte, Metadaten und den Verweis auf die Bilddateien (in beschnittener Form, JPG) und die Ganzseiten PDFs.
Updates sind bei dieser Schnittstelle ausgeschlossen und werden nicht übertragen.
Der Export kann typischerweise neben den Objekten (innerhalb der E-Paper Objekte) auch mit folgenden Parametern (per Ausgabe-Datei) konfiguriert werden:
Artikel-Id - Enthält die Id des Artikels.
Lieferant - Enthält die Id des Lieferanten.
Quelle - Enthält die Id der Quelle.
Erscheinungstag - Enthält den Erscheinungstag der Ausgabe.
Von/Bis Wochentag - Bestimmt die Wochentage des Exports.
Stunde/Minute - Bestimmt die Uhrzeit des Exports.
Für Informationen bezüglich der Information die wir von Ihnen benötigen, schauen Sie bitte auf die Mitwirkungspflichten.
Hilfestellung: [2-01-1] Customizing E-Paper
Default Werte
Falls die Frist für die Belieferung der Mitwirkungen nicht eingehalten wurde, wird PEIQ den Export für ein beliebiges Objekt einrichten. Die Funktionalität der Schnittstelle bleibt dabei garantiert, jedoch ist die nachfolgende Anpassung der Objekte vom Kunden kostenpflichtig zu beantragen.
Aufruf (automatischer Trigger)
Die Übertragung der Daten wird automatisiert zu einem festgelegten Zeitpunkt veranlasst (abhängig vom Erscheinungstag). Diese Übertragung wir je Ausgabe einmal angestoßen. Somit sind Updates ausgeschlossen.
Folgende Metadaten der Artikel können übertragen werden
Ort
Ressort
Autor-Name
Folgende Inhaltsdaten der Artikel können übertragen werden
Dachzeile
Titel
Unterzeile
Vorspann
Text mit Formatierungen:
Absatz
Umbrüche <br>
Kursiv <i>
Bold <b>
Links <a href=""></a>
Zwischentitel
Listen <ul>, <li>
Initial <big>
Verweis auf zugehörige Bilddateien mit Angabe der Beschriftung / Bildunterschrift und dem Fotonachweis
LayoutText-Bereiche werden nicht als Inhaltsdaten der Artikel übertragen. Wenn ein Artikel nur aus LayoutText-Bereichen besteht und keine der oben aufgelisteten Textbereiche (z.B. Dachzeile, Unterzeile, Text) beinhaltet, wird kein klickbarer Bereich übertragen. Auch die Artikelinhalte werden nicht für den Lesemodus im E-Paper exportiert.
Ü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 Dritten “abzuräumen”.
Namenskonvention
ZIP-/XML-Dateien
Die ZIP-Dateien und das Ausgaben-XML werden immer nach dem Schema (<Lieferanten-ID>-)<Quelle-ID>-<Erscheinungstag> übertragen, d.h.:
(<Lieferanten-ID>-)<Quelle-ID>-<Erscheinungstag>.zip
(<Lieferanten-ID>-)<Quelle-ID>-<Erscheinungstag>.xml
Bild-Dateien
image_<ID>.jpg
Ganzseiten-PDF
pagepdf_<ID>.pdf
Übertragung der Binärdaten mit Metadaten
Beim Export der E-Paper-Produkte wird in ein entsprechendes Verzeichnis auf dem sFTP-Server ein ZIP-File je Ausgabe abgelegt. Dies enthält je ein Ausgaben-XML, alle Bilder (nur “DBild”, nicht “DLogo”) als jpg und die Ganzseiten-PDFs.
Ausgaben-XML
Das Wurzelelement der XML-Datei heißt artikel-liste. Es folgt der Aufbau der XML-Struktur mit den Attributen.
Inhalte der Artikel
metadaten - Enthält Metadaten der Quelle und des Artikels.
artikel-id - Enthält die artikelspezifische ID.
quelle - Enthält Metadaten der Quelle und des Artikels
quelle-id - Enthält die quellenspezifische ID
name - Enthält den Namen der Zeitung.
datum - Enthält das Erscheinungsdatum des Artikels.
inhalt - Enthält den Artikel-Inhalt.
titel-liste - Enthält die Titel-Elemente eines Artikels.
dachzeile - Enthält die Dachzeile des Artikels.
titel - Enthält den Titel des Artikels.
untertitel - Enthält den Untertitel des Artikels.
text - Enthält den Text des Artikels mit folgenden möglichen Formatierungen:
absatz - Enthält Artikel-Text.
br - Umbrüche.
i - Kursiv.
b - Bold.
a href="" - Links.
zwischentitel - Enthält Zwischentitel.
ul, li - Enthält Listen.
big - Enthält Initiale.
bild - Angabe des Dateinamens des mitgelieferten Bildes.
beschriftung - Angabe der Bildunterschrift.
Beispiel eines Article-XML
<?xml version="1.0" encoding="UTF-8"?>
<!-- Der Beispiel Artikel enthält nur die XML-Elemente, die für die korrekte Anlieferung bei einem Artikel mindestens vorhanden sein müssen -->
<artikel-liste xsi:noNamespaceSchemaLocation="pmg-artikel-liste.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<artikel>
<metadaten>
<artikel-id>u1713875747</artikel-id>
<quelle>
<quelle-id>BSZEI</quelle-id>
<name>Beispiel-Zeitung</name>
<datum>15112016</datum>
</quelle>
</metadaten>
<inhalt>
<titel-liste>
<titel>Artikel-Beispiel 2</titel>
</titel-liste>
<text>
<absatz>Artikeltext</absatz>
<bild>beispielbild.jpg</bild>
</text>
</inhalt>
</artikel>