Transportverfahren | sFTP (Anlieferung in der PEIQ Cloud durch Dritte) |
|---|---|
Objekt | XML, Bilder als JPG, PNG, PDF, TIF, TIF, Gif, Bmp, SVG, RAW, WEBP, HEIC, EMF |
Trigger | automatisch, optional manuell |
Unterstützte Drittsysteme | Typische Anbindungen sind Archive (Seiten-, Artikel-, Bild-Archive) in Drittsystemen und Drittsysteme zur Content-Erstellung (Bild-Anlieferung vom Drittsystem) |
Beispieldaten | siehe unten |
Typische Drittsysteme | -- |
Mit der hier beschriebenen Importfunktion können einzelne Bilder (für Archiv oder Produktion) durch Dritte auf dem sFTP-Server zur Verfügung gestellt werden und von dort aus nach NGen importiert werden.
Die Datenanlieferung und der Import nach NGen erfolgen in der PEIQ Cloud im sFTP-Bereich (sftp://data.peiq.cloud/…). Typische Anbindung sind Archive und Drittsysteme zur Content-Erstellung.
Funktionalitäten des/der [Schnittstelle]
Import einzelner Bilder (für Archiv oder Produktion) optional mit Metadaten-XML
Übertragung via sFTP
Inhaltsverzeichnis
Mitwirkungspflichten/Beistellung des Kunden
Bereitstellung Textbilder (inkl. diverser Fälle (Metadatum, Format, Farbraum, etc.) zum Kontrollieren und für die Freigabe seitens des Kunden für den Massenimport siehe Mitwirkungspflicht: Archiv - Bereitstellung Testbilder und DAM-Größe
Bereitstellung der Bilder im importierfähigen Format
Übertragung der Daten
Für ein Bild wird eine Bilddatei mit oder ohne image-XML nach NGen importiert. Das im image-XML angegebene Bild muss (unbeschnittene Originalbilder) auf dem sFTP-Server vorhanden sein (Dateiname nach dem Schema image_<externe ID>_<timestamp>.<Endung des Dateiformats z.B. “jpg”>).
Werden zu einem Bild keine Metadaten (neben den im Bild enthaltenen IPTC-Daten) benötigt, können Bilder auch ohne image-XML auf dem sFTP-Server abgelegt werden.
Erfolgt ein Update, d.h. in NGen ist bereits ein Bild zu der im image-XML angegebenen externen ID vorhanden, wird das bestehende Bild in NGen upgedatet.
Das Update des NGen-Bildes erfolgt auch, wenn das Originalbild in NGen nachbearbeitet (z.B. durch Vergabe von Metadaten, Verschlagwortung) wurde. Änderungen am Originalbild haben keine Auswirkung auf bereits erstellte Kopien.
Usecases
Übernahme eines Bildarchivs von einem Drittsystem nach NGen
Content-Erstellung von Bildern in einem Drittsystem, die in NGen für Print oder Online (z.B. Verwendung in CREATE oder für EPaper) weiterverwendet werden sollen
Die zu übertragenden Bilder verfügen nicht über ausreichende oder die gewünschten Metadaten in den IPTC-Daten. Zusätzliche oder die gewünschten Metadaten sollen bei der Übertragung der Bilder anhand von zugehörigen Metadaten-XMLs in PRINT NGEN an den Bildern gesetzt werden.
Drittsystem bevorzugt die Übertragung per sFTP gegenüber der Übertragung per API über den Endpunkt POST /images der DAM API, vgl. [0-21] PEIQ DAM-API
Import der Daten
Zum Import läuft in NGen eine Warteschlange, die folgende Daten importiert:
Die image-XMLs und zugehörigen Bilder:
Für jedes image-XML mit zugehöriger Bilddatei wird jeweils ein Originalbild in NGen erstellt. Die im image-XML angegebenen Metadaten werden am Originalbild in NGen upgedatet.
Die Bilddateien (ohne zugehöriges image-XML oder Referenz in einem page- oder article-XML):
Für jede eigenständige, d.h. in keinem XML referenzierte Bilddatei wird jeweils ein Originalbild in NGen erstellt.
Der Import läuft im 1-min-Takt.
Import Trigger
Standardmäßig erfolgt der Import durch eine Warteschlange, die im 1min-Takt abgearbeitet wird.
Übertragungsart: sFTP
Der Import der Daten erfolgt von einer Destination im sFTP-Bereich (sftp://data.peiq.cloud/…) in der PEIQ Cloud. Diese Daten müssen vom Anlieferer (Dritten) zur Verfügung gestellt werden und werden durch NGen “abgeräumt” (d.h. nach dem Import werden die entsprechenden Daten auf dem sFTP-Server gelöscht).
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"
Bild-Dateien
image_<externe ID>_<timestamp>.<Endung des Dateiformats z.B. “jpg”>
XML
image_<externe ID>_<timestamp>.xml
Übertragung der Binärdaten
Beim Export der Daten durch den Anlieferer auf den sFTP-Server müssen zunächst die Binärdaten in ein entsprechendes Verzeichnis gelegt werden. Dies umfasst die Bilder als JPG, PNG, PDF, TIF, TIF, Gif, Bmp, SVG, RAW, WEBP, HEIC oder EMF.
Übertragung der Metadaten
Im nächsten Schritt müssen die Metadaten im gleichen Verzeichnis des sFTP-Servers abgelegt werden. Die XML-Datei muss dabei bildweise geschickt werden. Mit dem Import dieses XMLs werden die Metadaten am Bild upgedatet.
Image-XML
Das Wurzelelement der XML-Datei heißt image. Es folgt der Aufbau der XML-Struktur mit den Metadaten des Bildes.
Image
id = ID des Bildes (beim Archivimport die externe ID des Drittanbieters, Eigenschaft in NGen: DBildArchivID)
status = Status (Eigenschaft in NGen: Status)
object = Objekt (DBildObjekt und ggf. auch Mandant)
underline (optional) = Bildunterschrift (Eigenschaft in NGen: Text/BU)
source = Bildquelle innerhalb der BU (Eigenschaft in NGen: Text/BU/Bildquelle)
caption = Caption (Eigenschaft in NGen: "Text/TagName!=BU,Beschreibung, IptcUeb")
filename = Bilddateiname (Eigenschaft in NGen: BildDateiName)
honorar_id = Honorarkürzel (Eigenschaft in NGen: DBildHonEmpfaenger)
origin = Bildursprung (Eigenschaft in NGen: BildUrsprung)
by_line = Autorname (Eigenschaft in NGen: IptcAN)
edition = Ausgabe (Kürzel)(DBildAusgabe)
category = Ressort (Eigenschaft in NGen: IptcRes)
location = Ort (Eigenschaft in NGen: IptcStadt)
credit = Objektrecht/Copyright (Eigenschaft in NGen: IptcOR)
country = Land (Eigenschaft in NGen: IptcLand)
date_time_created = Aufnahmedatum (Eigenschaft in NGen: IptcED)
object_name = Objektname (Eigenschaft in NGen: IptcON)
service_identifier = Dienst (Eigenschaft in NGen: IptcDie)
special_instructions = Kommentar (Eigenschaft in NGen: IptcKom)
title = Titel/Überschrift (Eigenschaft in NGen: IptcUeb)
urgency = Priorität (Eigenschaft in NGen: IptcPri)
keywords/keyword = Schlagwörter (Eigenschaft in NGen: SchlagwortXml)
type = person (für Personen) / location (für Orte) / organisation (für Organisationen) / topic (für allgemeine Schlagwörter)
priority = Priorität von 1 bis 5
usage_instructions = Verwendungshinweis für zurückgezogene Bilder (Eigenschaft in NGen: DBildVerwendungsHinweis)
Beispiel
<?xml version="1.0" encoding="utf-8"?> <image> <id>251-2298349</id> <status>Original</status> <object>mz</object> <underline>"Bridgerton" zählt zu den erfolgreichsten Netflix-Serien aller Zeiten.</underline> <source>privat</source> <caption>Bridgerton</caption> <filename>Beispielbild.jpg</filename> <honorar_id>mm</honorar_id> <origin>Archiv A</origin> <by_line>Max Mustermann</by_line> <edition>ma</edition> <category>pol</category> <location>Bergkirchen</location> <credit>Getty Images/iStockphoto</credit> <country>Deutschland</country> <date_time_created>31.05.2022 11:27</date_time_created> <object_name>Kulturzentrum</object_name> <service_identifier>dpa</service_identifier> <special_instructions>Kommentar</special_instructions> <title>Erfolgreiche Netflix-Serie</title> <urgency>3</urgency> <keywords> <keyword type="person" priority="1">Patrick Dempsey</keyword> <keyword type="organisation" priority="5">American Broadcasting Company</keyword> <keyword type="location" priority="3">USA</keyword> <keyword type="topic" priority="5">Serie</keyword> </keywords> <usage_instructions></usage_instructions> </image>
Maßgebliche DB-Tabellen
DBild