PEIQ Knowledge Base
[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 | XML, PDF, JPG |
Trigger | automatisch, optional manuell |
Typische Drittsysteme | Typische Anbindungen sind E-Paper-Viewer/Lösungen oder Content-Syndikatoren |
Beispieldaten | siehe unten |
Mit der hier beschriebenen Exportfunktion können Ausgaben, Seiten, Artikel sowie Bilder zur Abholung durch Dritte zur Verfügung gestellt werden. Dies geschieht in der PEIQ Cloud im sFTP-Bereich (sftp://data.peiq.cloud/…). Typische Anbindungen sind E-Paper Viewer/Lösungen oder Content-Syndikatoren.
Funktionalitäten des Exports von Ausgaben mit Seiten, Artikel und Bilder
Export von Ausgaben inkl. Seiten, Artikel und Bilder
Ü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.
Usecases
Bereitstellung von Ausgaben aus PRINT NGEN mit zugehörigen Seiten und deren Artikel und Bilder für E-Paper-Viewer/Lösungen oder Content-Syndikatoren von Drittsystemen
Produzieren z.B. der Mantelseiten für einen Partnerverlag/Kunden; ist beim Partnerverlag/Kunden PRINT NGEN im Einsatz, können die Daten aus dieser Schnittstelle exportiert und beim Partnerverlag/Kunden über die Schnittstelle [0-10-2] INBOUND Printseiten mit zugehörigen Artikeln und Bildernarchived importiert werden
Ausgabe über ExportObjekt “E-Paper-Produkt”
Nach dem Stufen der Seiten eines redaktionellen Druckprodukts auf den Status “Produzieren”, erhalten die Seiten den Status “Produziert” und den EPaperStatus “FuerSeitenPDF” bzw. anschließend “FuerProduktion”. Sofern das Druckprodukt als sogenanntes “E-Paper-Objekt” markiert ist (siehe Hilfestellung: [2-01-1] Customizing E-Paper), wird automatisch im Hintergrund ein “E-Paper-Produkt” angelegt bzw. aktualisiert. (Für weitere Infos siehe E-Paper erstellen, öffnen, aktualisieren und exportieren.) Es ist möglich, die Automatisierung manuell zu übersteuern.
Dieses E-Paper-Produkt enthält alle Seiten (Einzelseiten, Archivseiten bzw. Ganzseiten) mit entsprechenden Bereichen (Boxen für Positionsinfo der Artikel) und dient als Grundlage für den Export. Ein E-Paper-Produkt kann in der Programmoberfläche vor dem Export vom Nutzer betrachtet werden.
Übertragung der Daten
Für jede Seite innerhalb des ExportObjekt “E-Paper-Produkt” wird ein Page-XML und ein PDF der Seite erzeugt und übertragen. Enthält eine Seite Bilder, so werden diese als JPG-Datei (in beschnittener Form) mitgeliefert.
Sind alle Seiten vollständig, wird final noch das “issue_<ID>_<timestamp>.xml” der Ausgabe mit den Seitenreferenzen geschickt. In diesem XML sind alle Seiten aufgelistet, die in der Ausgabe enthalten sind, so dass die zuvor gesendeten Seiten zugeordnet werden können. Zusätzlich wird der Status des Produktes übergeben. Auch das Übergeben eines Start- und Enddatums der Publikation ist möglich.
Bei einer Aktualisierung werden erneut die geänderten page-XMLs (inkl. Bilder und page-PDF) sowie abschließend wieder das issue-XML übertragen.
Page-XML
Im Page-XML werden für jeden Artikelcontainer die Koordinaten auf der Seite ausgegeben. Wenn ein Artikel ohne Artikelcontainer auf der Seite frei gelayoutet wurde, wird für jeden Textbereich des Artikels eine Positionsinfo ausgegeben.
Bilder
Bei Bildern wird zwischen Bildern in Artikeln und Bilder, die direkt auf der Seite ohne Artikel platziert sind, unterschieden.
Bilder, die Bestandteil eines Artikels sind, werden im Page-XML beim jeweiligen Artikel referenziert und benötigen keine Bildgeometrie, da bereits die Koordinaten des Artikels übertragen werden. Dementsprechend sind für diese Bilder keine Koordinaten im XML enthalten. Diese Bilder werden immer mit Referenzierung im Page-XML und Bilddatei ans E-Paper exportiert.
Für Bilder, die direkt auf der Seite ohne Artikel platziert sind, werden standardmäßig die Bildgeometrien im Page-XML ausgegeben und die Bilddatei exportiert, sodass diese im E-Paper klickbar sind. Falls ein Bild (z. B. ein Hintergrundbild) nicht exportiert werden soll, kann dies manuell über die Bildeigenschaft “EPaperExport” eingestellt werden.
Standardmäßig ist die Eigenschaft “EPaperExport” leer. Wenn die Eigenschaft leer oder mit “ja” befüllt ist, sind die direkt auf einer Seite platzierten Bilder im E-Paper-Export enthalten. Für Bilder in Artikeln hat die Einstellung “EPaperExport” keine Auswirkung. Diese werden immer mit exportiert.
Sollen einzelne Bilder nicht ans E-Paper exportiert werden, kann am Bildcluster manuell per Kontextmenüpunkt “EPaperExport=nein” eingestellt werden. Bei einem auf einer Seite platzierten Bild muss per Doppelklick in den Bildbereich reingeklickt werden, sodass grüne Anfasser erscheinen.
Bilder mit “EPaperExport=nein” werden auf der Seite mit der Ikone oben links am Bildbereich visualisiert.
Wenn generell alle Bilder von einem oder mehreren Asset-Importen nicht ans E-Paper exportiert werden sollen, kann dies kund:innenspezifisch in der Werteliste “EPaperBildExport” eingestellt werden. Bei diesen Bildern wird direkt beim Import automatisch “EPaperExport=nein” gesetzt.
Wird eine kund:innenspezifische Werteliste “EPaperBildExport” benötigt, ist dies individuell im Service Desk anzufragen.
Enthält ein Bild beim Import über den sFTP-Server nach PRINT NGEN (z. B. Automatischer Asset-Import von grafischen Elementen) einen Weblink im Metadatum “exif:UserComment”, wird dieser in die PRINT NGEN Bild-Eigenschaft “LinkURL” übertragen, sofern beim Import das XMPLesen aktiviert ist. Diese URL wird beim EPaper-Export im Page-XML im Attribut “<image link=””>” übertragen, sodass im E-Paper-Reader bei Klick auf das Bild zur externen URL gewechselt werden kann.
Fehlerhafte XML-Struktur
Ist auf einer Seite ein Artikel mit fehlerhafter XML-Struktur platziert (d. h. nach Anwenden der XSLT-Stylesheets ist das XML des Artikels nicht valide), wird dieser Artikel inkl. zugehöriger Bilder im page-XML übersprungen, damit die Seite trotz des fehlerhaften Artikels übertragen werden kann. Entsprechend ist der Artikel zwar auf dem PDF der Seite vorhanden, es gibt jedoch keinen klickbaren Bereich.
Eine fehlerhafte XML-Struktur kann durch Schachtelung von Tags entstehen. Ist im Printartikel beispielsweise folgende Schachtelung enthalten, führt das bei der Umwandlung in das E-Paper-Tagging zu einem Fehler:<Kursiv><Frage>Wie heißt die Frage?</Frage></Kursiv>
Entsprechend der Tabelle unter Produktübergreifender Standard: Tags/Makros/Bereiche für XSLT Stylesheets erfolgt die Umwandlung in: <em><p class="question">Wie heißt die Frage?</p></em>
Diese Schachtelung ist nicht erlaubt.
Wird die Schachtelung umgedreht, d.h. in <Frage><Kursiv>Wie heißt die Frage?</Kursiv></Frage> geändert, ist die Struktur im page-XML nach dem Anweden des XSLT-Stylesheets korrekt und die Artikelinhalte werden somit im XML übertragen mit <p class="question"><em>Wie heißt die Frage?</em></p>.
Export Trigger
Export einzelner Seiten bei der E-Paper-Produktion
Standardmäßig wird die Übertragung der Daten einer E-Paper-Seite automatisiert veranlasst, sobald eine Printseite (unabhängig vom Erscheinungstag) im EPaperStatus “FuerProduktion” für das E-Paper produziert wird.
Die Übertragung der Daten kann alternativ auch manuell durch erneutes Stufen der Printseite auf “Produziert” angestoßen werden.
Bei einer Seite, die an mehrere Durchlaufseiten vererbt wird, werden die Export-Daten nur einmalig für das Mutterprodukt und nicht für jedes Tochterprodukt exportiert. Im Issue-XML des Tochterproduktes ist die CID der Mutterseite referenziert. Eine layouterbende Seite wird separat auf Produzieren gestuft. Sie wird auch im E-Paper als eigenständige Seite behandelt und daher für das Tochterprodukt exportiert.
Export eines gesamten E-Paper-Produktes
Über den Aufruf des Menüpunktes „Exportieren mit allen Seiten“ am E-Paper-Produkt kann der Export aller Seiten des selektierten E-Paper-Produktes angestoßen werden.
Diese Übertragung kann mehrfach angestoßen werden. Der Zeitpunkt der letzten Übertragung wird unter “ExportZeit” am E-Paper-Produkt vermerkt.
Bei der ersten und auch allen weiteren Übertragungen werden immer alle Daten exportiert. Seiten, die noch nicht fürs E-Paper produziert wurden, werden leer 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 vom Abnehmer (Dritten) “abzuräumen”.
Namenskonvention
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"
pagepdf_<ID>_<timestamp>.pdf
Bild-Dateien
image_<ID>_<timestamp>.jpg
XML
page_<ID>_<timestamp>.xml
issue_<ID>_<timestamp>.xml
Übertragung der Binärdaten
Beim Export der E-Paper-Produkte werden zunächst die Binärdaten in ein entsprechendes Verzeichnis auf dem sFTP-Server abgelegt. Dies umfasst das PDF der einzelnen Seite und alle enthaltenen Bilder (nur “DBild”, nicht “DLogo”) als jpg.
Übertragung der Metadaten
Im nächsten Schritt werden die Metadaten im gleichen Verzeichnis des sFTP-Servers abgelegt. Die XML-Dateien werden dabei seitenweise geschickt.
Page-XML
Das Wurzelelement der XML-Datei heißt publication. Es folgt der Aufbau der XML-Struktur mit den Attributen und den kundenspezifischen Elementen.
Sind in der kundenspezifischen Konfiguration Teilseiten vorhanden