PEIQ Knowledge Base

[0-10-4] INBOUND Bilder mit Metadaten-XML

Owned by Violetta Stegen, created
Last updated: 2024-08-28 by Melanie Lutz
5 min read

Transportverfahren

sFTP (Anlieferung in der PEIQ Cloud durch Dritte)

Objekt

Metadaten-XML, Original-Bilder Dateigröße: >500 KB, Bilder als JPG, PNG, PDF, TIF, TIF, Gif, Bmp, SVG, RAW, WEBP, HEIC, EMF (inkl. IPTC-Infos)

Trigger

automatisch, optional manuell, große Datenmengen sind vorher abzustimmen

Unterstützte Drittsysteme

Typische Anbindungen sind 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 PRINT NGEN importiert werden.

Die Datenanlieferung und der Import nach PRINT 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 Bildimports mit Metadaten-XML

  • Bildimport (für Archiv oder Produktion) optional mit Metadaten-XML via sFTP

  • Updates der Bilder und Metadaten

Inhaltsverzeichnis

Mitwirkungspflichten der Kund:innen

  1. Bereitstellung Textbilder inkl. diverser Fälle (Metadatum, Format, Farbraum etc.) zur Kontrolle und für die kund:innenseitige Freigabe für den Massenimport (siehe ).

  2. Bereitstellung der Bilder im importierfähigen Format.

Allgemeine Beschreibung

Zur Übernahme von Bildern inkl. Metadaten in den IPTC-Daten aus einem Drittsystem nach PRINT NGEN werden zunächst die Bilder inkl. ihrer IPTC-Daten von einem sFTP-Server abgeholt.

Zu jedem Bild kann auf dem sFTP ein begleitendes Metadaten-XML abgelegt sein, das ebenfalls Metadaten enthalten kann und nach/mit dem Import des Bildes importiert wird.

Die Daten im XML überschreiben ggf. die IPTC-Infos, die aus dem Bild ausgelesen wurden, in den PRINT NGEN Eigenschaften, d. h. das XML ist an dieser Stelle die führende Datenquelle.

Soll zu einem späteren Zeitpunkt ein bereits in PRINT NGEN vorliegendes Bild aktualisiert werden, ist es ausreichend, wenn ein Metadaten-XML ohne zugehörige Bilddatei auf dem sFTP-Server angeliefert wird.

Für die Übernahme der Metadaten nach PRINT NGEN sind fixe Mapping-Logiken definiert.

Die aus dem Drittsystem importierten Bilder können in der Web-Recherche in CREATE und in der Client-Recherche in PRINT NGEN gesucht und verwendet werden.

Beim Import der Bilder wird jeweils aus dem Metadaten-XML das Objekt ausgelesen. Abhängig davon, ob ein Objekt angegeben ist, wird das Bild in eine entsprechende (objekt- und) schnittstellenspezifischen Mappe zum Tagesimport gelegt.

Übertragung der Daten

Für ein Bild wird eine Bilddatei mit oder ohne Metadaten-XML nach PRINT NGEN importiert. Das im Metadaten-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, neben den im Bild enthaltenen IPTC-Daten, keine Metadaten benötigt, können Bilder auch ohne Metadaten-XML auf dem sFTP-Server abgelegt werden.

Alle Bilder, die über diese Schnittstelle nach PRINT NGEN importiert werden, erhalten die Eigenschaft “DBildImportArt=BilderMitMetadatenXML”. Dadurch können diese Bilder von den Bildern unterschieden werden, die über andere Schnittstellen importiert wurden.

Erfolgt ein Update, d. h. in PRINT NGEN ist bereits ein Original-Bild zu der im Metadaten-XML angegebenen externen ID mit der Eigenschaft “DBildImportArt=BilderMitMetadatenXML” vorhanden, wird das bestehende Bild in PRINT NGEN aktualisiert. 

Für das Update kann die Bilddatei mit Metadaten-XML angeliefert werden. Es ist jedoch auch möglich, nur ein aktualisiertes Metadaten-XML anzuliefern.

Über die Schnittstelle werden ausschließlich Bilder mit der Eigenschaft “DBildImportArt=BilderMitMetadatenXML” erstellt und aktualisiert. Existieren in PRINT NGEN mehrere Original-Bilder mit der im XML angegebenen externen ID, so erfolgt demnach kein Update, wenn am Bild in PRINT NGEN in der Eigenschaft “DBildImportArt” nicht der Wert ”BilderMitMetadatenXML” gesetzt ist. Dadurch soll sichergestellt werden, dass bei einem Update genau ein Bild in PRINT NGEN gefunden und aktualisiert werden kann.

Zu einer externen ID (“DBildArchivID”) darf es folglich immer nur ein Bild mit “DBildImportArt=BilderMitMetadatenXML” und “Status=Original” geben.

Das Update eines Bildes erfolgt nur an einem PRINT NGEN Bild mit dem Status “Original” und “DBildImportArt=BilderMitMetadatenXML” - auch wenn das Originalbild in PRINT NGEN bereits nachbearbeitet wurde (z. B. durch Vergabe von Metadaten, Verschlagwortung).

Änderungen am Originalbild haben keine Auswirkung auf bereits erstellte Kopien.

Für den Import wird von einer durchschnittlichen Zeit von 5 Sekunden pro Bild ausgegangen - abhängig von der Größe des Bildes.

Bei der Übertragung der Bilder sind keine Koordinaten erforderlich. 

Format

Es werden nur Original-Bilder mit einer Dateigröße >500 KB für den Archiv-Import vorgesehen.

Importierfähige Datenformate sind:

  • highres png

  • jpg

  • pdf

  • tif

  • (gif, bmp, svg, raw, webp, heic, emf)

Die Metadaten der Bilder können im Bild selbst in den IPTC-Daten mitgegeben werden.

Farbraum

Idealerweise nur RGB (CMYK geht theoretisch auch, wird jedoch nicht empfohlen, da nicht für die automatische Bildoptimierung sowie die Verwendung für Online geeignet).

Einlaufen der Bilder in Mappen in PRINT NGEN

Beim Import der Bilder wird jeweils aus dem Metadaten-XML das Objekt ausgelesen.

Ist ein Objekt angegeben, wird das Bild in eine objekt- und schnittstellenspezifischen Mappe zum Tagesimport gelegt:

  • Obermappen-Name: <Objekt>_Tagesimport (<Objekt>: Objektkürzel aus dem Metadaten-XML in Großbuchstaben)

  • Untermappen-Name: <Objekt>_Produktionsbilder_taeglich (<Objekt>: Objektkürzel aus dem Metadaten-XML in Großbuchstaben)

Ist kein Objekt vergeben, wird das Bild in einer allgemeinen schnittstellenspezifischen Mappe eingehängt:

  • Obermappen-Name: <SystemName>_Tagesimport (<SystemName>: KundenKürzel + Test/Prod, z. B. “MasterTest”)

  • Untermappen-Name: Produktionsbilder_taeglich

Ist eine entsprechende Mappe in PRINT NGEN noch nicht vorhanden, erstellt der Workflow diese automatisch.

Usecases

  • Initiale, einmalige Übernahme eines Bildarchivs von einem Drittsystem nach PRINT NGEN.

  • 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.

  • Updates der Bilder und Metadaten sollen per Schnittstelle möglich sein. Werden keine Updates bzw. der Import zusätzlicher Metadaten (Metadaten-XML) benötigt, kann alternativ die Schnittstelle verwendet werden.

Import der Daten

Zum Import läuft in PRINT NGEN eine Warteschlange, die folgende Daten importiert:

  • Die Bilddateien mit zugehörigen Metadaten-XMLs:

    • Gibt es bereits ein Bild zur externen ID des Bildes mit “DBildImportArt=BilderMitMetadatenXML”, wird das bestehende Bild in PRINT NGEN aktualisiert.

    • Wenn es noch kein Bild gibt, wird ein neues angelegt.

    • Die Metadaten werden aus den IPTC-Infos ausgelesen und in die PRINT NGEN Eigenschaften übernommen. Im Anschluss an das Auslesen der IPTC-Infos werden die Metadaten aus dem mitgelieferten Metadaten-XML ausgelesen und in die PRINT NGEN Eigenschaften übernommen. Metadaten, die aus den IPTC-Infos ausgelesen wurden, werden somit in den PRINT NGEN Eigenschaften ggf. durch die Metadaten aus dem Metadaten-XML überschrieben.

  • Die Bilddateien (ohne zugehöriges Metadaten-XML):

    • Gibt es bereits ein Bild zur externen ID des Bildes mit “DBildImportArt=BilderMitMetadatenXML”, wird das bestehende Bild in PRINT NGEN aktualisiert.

    • Wenn es noch kein Bild gibt, wird ein neues angelegt.

    • Die Metadaten werden aus den IPTC-Infos ausgelesen und in die PRINT NGEN Eigenschaften übernommen.

  • Metadaten-XMLs ohne Bilddateien:

    • Im Anschluss an den Import der Bilddateien mit oder ohne Metadaten-XMLs werden die einzelnen Metadaten-XMLs ohne Bilddateien importiert.

    • Ein einzelnes Metadaten-XML darf nur in dem Fall angeliefert werden, wenn bereits ein Originalbild mit “DBildImportArt=BilderMitMetadatenXML” zu dieser externen ID in PRINT NGEN vorliegt.

    • Gibt es noch kein Bild mit dieser externen ID und “DBildImportArt=BilderMitMetadatenXML” in PRINT NGEN, tritt beim Import ein Fehler auf, da noch kein entsprechendes Bild zu dieser externen ID gefunden wird. Das XML wird somit auf dem FTP-Server in das Fehler-Verzeichnis verschoben.

  • Dateien, die mit einem Punkt im Dateinamen starten:

    • Dateien, die mit einem Punkt im Dateinamen starten, z. B. “.image_9876543210_08081000000.xml” werden noch geschrieben und dürfen daher von PRINT NGEN noch nicht importiert werden. Daher ignoriert PRINT NGEN beim Import alle Dateien, die mit einem Punkt starten und lässt diese im Import-Verzeichnis liegen.

  • 0 KB große Dateien:

    • 0 KB große Dateien werden direkt ins Fehler-Verzeichnis verschoben, da davon ausgegangen wird, dass z. B. die Verbindung beim Schreiben der Dateien unterbrochen wurde und die Dateien damit kaputt bzw. nicht vollständig sind.

    • Ausnahme - 0 KB große Dateien, die mit einem Punkt starten: Diese bleiben entsprechend der Regelung “Dateien die mit einem Punkt im Dateinamen starten” im Import-Verzeichnis liegen.

Der Import läuft im 1-Minuten-Takt. Je Durchlauf der Warteschlange werden maximal 100 Bilder / einzelne Metadaten-XMLs importiert.

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 PRINT 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"

Der Timestamp darf nicht für mehrere Bilder identisch sein.

Bild-Dateien

image_<externe ID>_<timestamp>.<Endung des Dateiformats z.B. “jpg”>

XML

image_<externe ID>_<timestamp>.xml 

Sonderzeichen im Dateinamen

Im Idealfall sollte die externe ID im Dateinamen der Bilder und XMLs nur aus den Zeichen 0-9, a-z, A-Z und “-” bestehen, um Probleme mit Sonderzeichen zu vermeiden.

Ü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.

Mapping Metadaten

vgl.

Ü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.

Metadaten-XML

Das Wurzelelement der XML-Datei heißt “image”. Es folgt der Aufbau der XML-Struktur mit den Metadaten des Bildes.

Image

Nr.

Tag

Beschreibung

PRINT NGEN Eigenschaft

Nr.

Tag

Beschreibung

PRINT NGEN Eigenschaft

1

<id>

ID des Bildes (beim Archivimport die externe ID des Drittanbieters)

DBildArchivID

2

<status>

Status

Status

3

<object>

Objekt

DBildObjekt und ggf. auch Mandant

4

<underline>

Bildunterschrift

Text/BU

5

<source>

Bildquelle innerhalb der BU

Text/BU/Bildquelle

6

<caption>

Caption

"Text/TagName!=BU,Beschreibung, IptcUeb"

7

<filename>

Bilddateiname

BildDateiName

8

<honorar_id>

Honorarkürzel

DBildHonEmpfaenger

9

<origin>

Bildursprung

BildUrsprung

10

<by_line>

Autorname

IptcAN

11

<edition>

Ausgabe

DBildAusgabe

12

<category>

Ressort

IptcRes

13

<location>

Ort

IptcStadt

14

<credit>

Objektrecht/Copyright

IptcOR

15

<country>

Land

IptcLand

16

<date_time_created>

Aufnahmedatum

IptcED

17

<object_name>

Objektname

IptcON

18

<service_identifier>

Dienst

IptcDie

19

<special_instructions>

Kommentar

IptcKom

20

<title>

Titel/Überschrift

IptcUeb

21

<urgency>

Priorität

IptcPri

22

<keywords>

<keyword priority="" type="">

</keywords>

Schlagwörter

  • 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

SchlagwortXml

23

<usage_instructions>

Verwendungshinweis für zurückgezogene Bilder

DBildVerwendungsHinweis

Beispiel

<?xml version="1.0" encoding="utf-8"?> <image> <id>251-2298349</id> <status>Original</status> <object>mz</object> <underline>&quot;Bridgerton&quot; 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>

Fehler beim Import

Tritt beim Import einer Datei ein Fehler auf, wird diese auf dem sFTP-Server in ein Unterverzeichnis “$fehler$” verschoben. Gibt es die Datei bereits im Fehler-Ordner, wird am Dateinamen eine Nummerierung mit “#1” angehängt, die entsprechend hochgezählt wird mit “#2” etc. , zum Beispiel:

  • image_123_0512174535345.xml

  • image_123_0512174535345#1.xml

  • image_123_0512174535345#2.xml etc.

Maßgebliche DB-Tabellen

“DBild”

Verwandte Seiten

Nur für PEIQ-Mitarbeiter:innen

Impressum