Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

--

...

Funktionalitäten des Bildimports mit Metadaten-XML

  • Import einzelner Bilder Bildimport (für Archiv oder Produktion) optional mit Metadaten-XML Übertragung via sFTP

  • Updates der Bilder und Metadaten möglich

  • Bilder können inkl. Metadaten in den IPTC-Daten aus einem Drittsystem nach PRINT NGEN übernommen werden. 

  • Dazu 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 NGen-Eigenschaften, d.h. das XML ist an dieser Stelle die führende Datenquelle.

  • Soll zu einem späteren Zeitpunkt ein bereits in NGEN vorliegendes Bild upgedatet 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.

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Mitwirkungspflichten/Beistellung des Kunden

  1. 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 Mitwirkungspflichten: [7-15] Archiv - Bereitstellung Testbilder und DAM-Größe

  2. Bereitstellung der Bilder im importierfähigen Format

Ü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 keine Metadaten (neben den im Bild enthaltenen IPTC-Daten) 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”, um diese von Bildern unterscheiden zu können, 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 upgedatet. 

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 diese Schnittstelle werden ausschließlich Bilder mit der Eigenschaft DBildImportArt = ”BilderMitMetadatenXML” erstellt und upgedatet. Existieren in PRINT NGEN mehrere Original-Bilder mit der im XML angegebenen externen ID, erfolgt entsprechend kein Update, wenn am Bild in NGEN in der Eigenschaft DBildImportArt nicht den Wert ”BilderMitMetadatenXML” gesetzt ist. Über diese Logik soll somit sichergestellt werden, dass bei einem Update genau ein Bild in NGEN gefunden und upgedatet werden kann.

D.h. es darf zu einer externen ID (DBildArchivID) immer nur ein Bild mit DBildImportArt = BilderMitMetadatenXML und Status = Original geben.

Das Update eines Bildes erfolgt entsprechend nur am NGEN Bild mit dem Status Original und DBildImportArt = ”BilderMitMetadatenXML” auch, wenn das Originalbild in PRINT NGEN bereits nachbearbeitet (z.B. durch Vergabe von Metadaten, Verschlagwortung) wurde. Änderungen am Originalbild haben keine Auswirkung auf bereits erstellte Kopien.

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

Bei der Übertragung der Bildern sind keine Koordinaten erforderlich. 

Info

Punkte, die mit dieser Schnittstelle NICHT abgedeckt sind,:

  • Wenn die gleiche externe ID in mehreren Drittsystemen vorliegt und diese Schnittstelle für die Anbindung an mehrere Drittsysteme verwendet wird, verursacht das aktuell bei einem Update eines Bildes einen Fehler. Bisher wurde hierfür keine Logik umgesetzt, da es diesen Fall in der Praxis noch nicht gibt.
    Beim Import wird geprüft, ob es bereits Bilder mit der externen ID, Status Original und DBildImportArt = ”BilderMitMetadatenXML” gibt. Hier wird nicht berücksichtigt, welcher Wert in der Eigenschaft BildUrsprung an den Bildern gespeichert ist und ob das mit dem Wert aus dem XML übereinstimmt.

  • Findet NGEN beim erstmaligen Import eines Bildes zu einer externen ID zuerst das Metadaten-XML auf dem sFTP-Server und ist die Bilddatei z.B. noch nicht auf dem FTP-Server fertig geschrieben bzw. generell nicht vorhanden, führt das aktuell zu einem Fehler. Das XML wird ins Fehler-Verzeichnis verschoben, da kein Bild in NGEN zur externen ID gefunden werden kann und somit kein Update eines Bildes mit den Infos aus dem XML möglich ist.
    Wenn später die Bilddatei fertig geschrieben ist bzw. die Bilddatei nachgeliefert wird, erhalten die Bilder in NGEN nicht die gewünschten Metadaten, da das XML bereits im Fehler-Verzeichnis liegt. Hier muss das XML erneut angeliefert werden.
    D.h. hier muss sichergestellt sein, dass das Bild vollständig auf dem FTP Server liegt, bevor das XML kommt.

Inhaltsverzeichnis

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

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 Mitwirkungspflichten: [7-15] Archiv - Bereitstellung Testbilder und DAM-Größe).

  2. Bereitstellung der Bilder im importierfähigen Format.

Allgemeine Beschreibung

Der Bildimport mit Metadaten-XML dient zur Übernahme von Bildern inkl. Metadaten aus einem Drittsystem nach PRINT NGEN. Zunächst werden die Bilder inkl. ihrer in den Binärdaten enthaltenen IPTC-Metadaten vom sFTP-Server abgeholt. Die Übernahmelogik der IPTC-Metadaten aus den Binärdaten der Bilddateien in die entsprechenden NGEN Eigenschaften ist in der separaten Doku Auslesen der IPTC-Tags bei Bildern beschrieben.

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.

Note

Zu einer externen ID (“DBildArchivID”) darf es folglich immer nur ein Bild mit “DBildImportArt=BilderMitMetadatenXML” und “Status=Original” geben. Andernfalls kann der Import nicht erfolgen und die entsprechenden Dateien werden ins Fehler-Verzeichnis verschoben.

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, ist aber schlechtwird jedoch nicht empfohlen, da nicht für autom. Bildoptimierung geeignet und bei die automatische Bildoptimierung sowie die Verwendung für Online problematischgeeignet)

...

.

Bitte informieren Sie sich bzgl. der Belieferung möglicher großer Datenmengen bei Ihrem/Ihrer Projektmanager:in, um eine Überlastung des Servers zu vermeiden

...

. PEIQ kann vorab dann ggf. entsprechende Vorkehrungen

...

treffen

...

.

Einlaufen der Bilder in Mappen in PRINT NGEN

...

  • 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. Entsprechend sollen zusätzliche Metadaten per Metadaten-XML angeliefert werden.

  • 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 [0-22] INBOUND Bilder (Archiv) verwendet werden.

...

Weitere Usecases, wie zum Beispiel die regelmäßige Übertragung von Bildern im normalen Betrieb,

...

erfolgen über die DAM API

...

Import

...

Trigger

Standardmäßig erfolgt der Import durch 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 NGEN Eigenschaften übernommen. Metadaten, die aus den IPTC-Infos ausgelesen wurden, werden somit in den 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 NGEN noch nicht importiert werden. Daher ignoriert NGEN beim Import alle Dateien, die mit einem Punkt starten und lässt diese im Import-Verzeichnis liegen.

  • 0KB große Dateien:

    • 0KB 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 - 0KB 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 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. https://peiq.atlassian.net/wiki/spaces/PPSD/pages/edit-v2/1501036583?draftShareId=947c00c9-067e-4a83-844d-2fbfd755d0a2

Ü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

...

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

Es können Tags weggelassen oder leer übertragen werden, wenn diese nicht benötigt werden. Wichtig hierbei ist, dass die in der Tabelle dokumentierte Reihenfolge der Tags eingehalten wird.

Metadaten werden nicht gesetzt, wenn die übergebenen Werte nicht zum Attributtyp (bspw. Zeichenfolge anstatt Datum/Uhrzeit für <date_time_created>) passen.

Beispiel

Code Block
<?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. , z.B.: image_123_0512174535345.xml, image_123_0512174535345#1.xml, image_123_0512174535345#2.xml etc.

Maßgebliche DB-Tabellen

DBild

Versionierung

Verwandte Seiten

Mit der Schnittstelle [0-10] INBOUND Seiten, Artikel, Bilder (jeweils für Archiv oder Produktion) können neben den Bildern inkl. Metadaten-XML auch

importiert werden. Mehr Informationen finden Sie unter den verlinkten Seiten.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

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

Prüfungen beim Import

Beim Import werden die angelieferten Files hinsichtlich der Namenskonvention geprüft. Damit eine Datei importiert wird, muss der Dateiname:

  • bei einer Bilddatei der Struktur “image_<externe ID>_<timestamp>.<Endung des Dateiformats z. B. “jpg”>” bzw. beim XML der Struktur “image_<externe ID>_<timestamp>.xml” entsprechen

  • mit “image_” starten

  • nach “image_” die externe ID enthalten, die nur aus folgenden Zeichen bestehen darf: a-z, A-Z, 0-9, “-” (Umlaute und andere Sonderzeichen als “-” sind nicht erlaubt)

  • nach der externen ID mit “_” vom Timestamp getrennt sein

  • als Timestamp 13-Ziffern enthalten

  • als Datei Extension eine Bilddatei-Endung oder “.xml” enthalten

Import der Daten

Zum Import läuft in PRINT NGEN eine Warteschlange, die die Bilder und XMLs in den nachstehenden Blöcken importiert.

Block 0: Prüfung, ob es zu liegengebliebenen XMLs inzwischen ein zugehöriges Bild gibt

Da es sein kann, dass beim letzten Import XMLs auf dem sFTP-Server lagen, zu denen es noch keine zugehörige Bilddatei auf dem sFTP-Server gab und zu deren externer ID in PRINT NGEN auch noch kein Bild mit Status “Original” und “DBildImportArt=BilderMitMetadatenXML” vorhanden war, werden zunächst diese XMLs geprüft.

Erkennbar sind diese XMLs an der folgenden Namenskonvention:

  • “image_<externe ID>_<timestamp>__<durch NGEN angehängter Timestamp>.xml”

Der durch PRINT NGEN angehängte Timestamp wird in UTC (Greenwich mean Time; Universal Time Coordinates), z. B. 20241115101530Z (auf Sekunden genau) mit zwei Unterstrichen getrennt an den angelieferten Dateinamen angehängt.

Für den durch PRINT NGEN angehängten Timestamp ist in PRINT NGEN eine Wartedauer hinterlegt. Diese liegt bei 10 Minuten. Ist diese Wartedauer abgelaufen und immer noch kein entsprechendes Bild in PRINT NGEN und auch keine Bilddatei zur externen ID auf dem sFTP-Server vorhanden, wird das XML ins Fehler-Verzeichnis verschoben. Ist die Wartedauer noch nicht abgelaufen, es liegt aber immer noch kein entsprechendes Bild in PRINT NGEN oder auf dem sFTP-Server vor, bleibt das XML zunächst auf dem sFTP-Server liegen, bis die Warteschlange das nächste Mal läuft.

Ist inzwischen ein Bild in PRINT NGEN oder auf dem sFTP-Server vorhanden, wird das XML umbenannt und der durch PRINT NGEN angehängte Timestamp aus dem Dateinamen entfernt. Klappt das Umbenennen nicht, da das XML mit diesem Dateinamen noch einmal angeliefert wurde und im Import-Verzeichnis liegt, wird die Datei mit dem angehängten Timestamp gelöscht.

Hier wird davon ausgegangen, dass die Datei mit dem gleichen Dateinamen, d. h. gleiche externe ID und gleicher Timestamp, auch den identischen Inhalt im XML hat.

Block 1: Import der Bilder mit/ohne zugehörige XMLs

Zunächst werden alle Bilder mit oder ohne zugehörige XMLs importiert. Hierbei wird je angelieferter Bilddatei geprüft, ob es bereits ein Bild zur externen ID mit Status “Original” und “DBildImportArt=BilderMitMetadatenXML” gibt. Falls ja, 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.

Zudem wird geprüft, ob auf dem sFTP-Server XMLs zu dieser externen ID vorhanden sind. Sind mehrere XMLs vorhanden, werden diese nach Timestamp aufsteigend sortiert.

Hierbei werden auch die XMLs mitberücksichtigt, die beim letzten Durchlauf der Warteschlange nicht importiert werden konnten, da es in PRINT NGEN noch kein Bild zur externen ID gab und auch noch keine zugehörige Bilddatei auf dem sFTP-Server vorhanden war. D. h. es werden die XMLs mitberücksichtigt, die in Block 0 umbenannt wurden, wobei der durch PRINT NGEN angehängte Timestamp entfernt wurde.

Das XML mit dem kleinsten Timestamp wird zuerst importiert. Alle weiteren XMLs werden anschließend entsprechend ihrer Reihenfolge mit aufsteigenden Timestamps herangezogen, um die Eigenschaften am NGEN-Bild zu aktualisieren.

Metadaten, die aus den IPTC-Infos ausgelesen wurden, werden somit in den PRINT NGEN Eigenschaften ggf. durch die Metadaten aus dem Metadaten-XML überschrieben.

Block 2: Import der einzelnen Metadaten-XMLs ohne Bilddateien

Ein einzelnes Metadaten-XML sollte nur in dem Fall angeliefert werden, wenn bereits ein Originalbild mit “DBildImportArt=BilderMitMetadatenXML” zu dieser externen ID in PRINT NGEN vorliegt oder wenn direkt im Anschluss die zugehörige Bilddatei auf dem sFTP Server angeliefert wird.

Im Anschluss an den Import in Block 1 werden die einzelnen Metadaten-XMLs ohne Bilddateien importiert.

Auch hier werden die XMLs mitberücksichtigt, die beim letzten Durchlauf der Warteschlange nicht importiert werden konnten, da es in PRINT NGEN noch kein Bild zur externen ID gab und auch noch keine zugehörige Bilddatei auf dem sFTP-Server vorhanden war. D. h. es werden die XMLs mitberücksichtigt, die in Block 0 umbenannt wurden, wobei der durch PRINT NGEN angehängte Timestamp entfernt wurde.

Alle gescannten XMLs werden entsprechend ihres Timestamps sortiert und nacheinander abgearbeitet. XMLs mit kleineren Timestamps werden zuerst importiert.

Beim Abarbeiten jedes XMLs wird geprüft, ob es ein Bild zur externen ID in PRINT NGEN gibt mit “Status=Original” und “DBildImportArt=BilderMitMetadatenXML”. Bilder mit zugehöriger Bilddatei zur externen ID wurden bereits in Block 1 berücksichtigt.

Falls es in PRINT NGEN bereits ein entsprechendes Bild zur externen ID gibt, werden die Eigenschaften an diesem NGEN-Bild anhand der im XML mitgelieferten Metadaten aktualisiert.

Gibt es zu einer im Dateinamen des XMLs angegebenen externen ID in PRINT NGEN noch kein Bild mit Status “Original" und “DBildImportArt=BilderMitMetadatenXML”, wird die Datei zunächst umbenannt, wobei an den ursprünglichen Dateinamen ein weiterer Timestamp angehängt wird. Diese XMLs entsprechen dann der folgenden Namenskonvention:

  • “image_<externe ID>_<timestamp>__<durch NGEN angehängter Timestamp>.xml”

Beim nächsten Durchlaufen der Warteschlange werden diese XMLs mit dem durch PRINT NGEN angehängten Timestamp in Block 0 geprüft.

Dateien, die nicht importiert werden

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

  • Dateien, die nicht der Namenskonvention entsprechen:

    • Dateien, die nicht der nachstehenden Namenskonvention entsprechen, können nicht importiert werden und werden somit ins Fehler-Verzeichnis verschoben.

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

      • “image_<externe ID>_<timestamp>.xml”

      • “image_<externe ID>_<timestamp>__<durch NGEN angehängter Timestamp>.xml”

    • Ausnahme: Dateien, die nicht der Namenskonvention entsprechen, aber mit einem Punkt starten. Diese bleiben entsprechend der Regelung “Dateien die mit einem Punkt im Dateinamen starten” im Import-Verzeichnis liegen.

Taktung der Warteschlange

Der Import läuft im 5-Sekunden-Takt. Je Durchlauf der Warteschlange werden maximal 100 Bilder / einzelne Metadaten-XMLs importiert. D. h. in Block 1 wird je Bilddatei gezählt, in Block 2 je XML.

Wurden bei einem Durchlauf der Warteschlange 100 Bilder / einzelne Metadaten-XMLs importiert, bricht die Warteschlange ab und startet beim nächsten Durchlauf wieder mit Block 0.

Beispiel

Liegen im Import-Verzeichnis 150 Bilddateien mit/ohne Metadaten-XMLs und 150 einzelne Metadaten-XMLs ohne zugehörige Bilddatei, werden beim ersten Durchlauf der Warteschlange - nach Timestamp aufsteigend - die ersten 100 Bilder mit/ohne XMLs importiert.

Wurden in der Zwischenzeit keine weiteren Dateien angeliefert, so werden beim zweiten Durchlauf die restlichen 50 Bilder mit/ohne XMLs importiert und die ersten 50, nach Timestamp aufsteigend sortierten, einzelnen Metadaten-XMLs ohne Bilddateien importiert.

Beim dritten Durchlauf werden die restlichen 100 einzelnen Metadaten-XMLs importiert, wieder unter der Voraussetzung, dass keine weiteren Dateien angeliefert wurden.

Falls in der Zwischenzeit weitere Dateien angeliefert werden, werden diese in Block 0, 1 und 2 mit berücksichtigt.

Ü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

Mehr dazu unter https://peiq.atlassian.net/wiki/spaces/PPSD/pages/edit-v2/1501036583?draftShareId=947c00c9-067e-4a83-844d-2fbfd755d0a2.

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

Übernahmelogik von Metadaten nach PRINT NGEN

Zunächst werden beim Import eines Bildes die IPTC-Metadaten aus der Bilddatei ausgelesen und in die PRINT NGEN Eigenschaften gemäß Auslesen der IPTC-Tags bei Bildern übernommen.

Für PRINT NGEN Eigenschaften sind maximale Zeichenlängen definiert, die nicht überschritten werden dürfen/können. Sind in einem IPTC-Feld also mehr Zeichen enthalten, als in der entsprechenden PRINT NGEN Eigenschaft gesetzt werden können, wird die Zeichenlänge abgeschnitten und so nach PRINT NGEN übernommen.

Das gleiche gilt auch für die Übernahme von Metadaten aus dem Metadaten-XML. Beim Überschreiten der maximal erlaubten Zeichenlänge wird auch hier der String verkürzt und anschließend in verkürzter Form in die PRINT NGEN Eigenschaft übernommen.

Bei Updates zu einem bereits in PRINT NGEN bestehenden Bild gilt folgendes:

  • Metadaten-Updates erfolgen nur über das Metadaten-XML. Wird also eine Bilddatei zu einer externen ID erneut mit erweiterten Metadaten angeliefert, so erfolgt hier kein Update der Eigenschaften in PRINT NGEN.

  • Wird ein Metadaten-XML für ein Update angeliefert, werden alle befüllten Tags für das Update der PRINT NGEN Eigenschaften herangezogen. Leere oder nicht mitgelieferte Tags werden nicht berücksichtigt. Demnach bleiben diese Eigenschaften in PRINT NGEN auf ihrem bisherigen Stand.

  • Soll eine Eigenschaft in PRINT NGEN leergesetzt werden, kann im entsprechenden Tag des XMLs der Wert “&lt;leer&gt;” mitgegeben werden. Das gilt für alle Eigenschaften außer <id>, <underline>, <source>, <caption>, <keywords><keyword priority="" type=""></keywords> (vgl. Tabelle unten).

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

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

Es können Tags weggelassen oder leer übertragen werden, wenn diese nicht benötigt werden. Wichtig hierbei ist, dass die in der Tabelle dokumentierte Reihenfolge der Tags eingehalten wird.

Metadaten werden nicht gesetzt, wenn die übergebenen Werte nicht zum Attributtyp (bspw. Zeichenfolge anstatt Datum/Uhrzeit für <date_time_created>) passen.

Beispiel

Code Block
<?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

Allgemein

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.

Fehler hinsichtlich der Namenskonvention

Die Namenskonvention für Bilddateien und XMLs ist unter https://peiq.atlassian.net/wiki/spaces/PPSD/pages/1050247173/0-10-4+INBOUND+Bilder+mit+Metadaten-XML#Namenskonvention detailliert definiert. Entspricht eine Datei nicht dieser Namenskonvention, wird die Datei ins Fehler-Verzeichnis verschoben.

Ausnahmen:

  • Der Dateiname fängt mit einem Punkt “.” an. In dem Fall bleiben die Dateien ebenfalls liegen, da PRINT NGEN davon ausgeht, dass die Datei noch geschrieben wird.

  • XMLs, die der Namenskonvention “image_<externe ID>_<timestamp>__<angehängter Timestamp>.xml” (angehängter Timestamp, z.B. "20241017142203Z", entspricht dem Timestamp: "2024-10-17 14:22:03Z") entsprechen, bleiben auch liegen. (Hinweis: Den angehängten Timestamp erstellt PRINT NGEN, wenn ein XML mit einer externen ID angeliefert wird, zu der es in PRINT NGEN noch kein Bild gibt. Wird während der Wartezeit von 10 Minuten kein zugehöriges Bild angeliefert, wird auch dieses XML ins Fehler-Verzeichnis verschoben.)

Mehr als ein Bild zur externen ID in PRINT NGEN vorhanden

Beim Import wird an den importierten Bildern (Bilder mit Status “Original”) in PRINT NGEN die Eigenschaft “DBildImportArt=BilderMitMetadatenXML” gesetzt. Andere Bildimporte setzen diese Eigenschaft nicht.

Bei Updates über den Bildimport mit Metadaten-XML werden nur Bilder im Status “Original” mit der Eigenschaft “DBildImportArt=BilderMitMetadatenXML” aktualisiert. Andere Workflows ändern den Wert der Eigenschaft “DBildImportArt” nicht mehr. Demnach gibt es keine Bilder, die nachträglich noch die Eigenschaft “DBildImportArt=BilderMitMetadatenXML” erhalten.

Zudem sind für Bilder mit “DBildImportArt=BilderMitMetadatenXML” keine Workflows vorgesehen, die an Bildern nachträglich noch den Status “Original” setzen.

Entsprechend sollten Bilder nur über den Bildimport mit Metadaten-XML sowohl den Status “Original” als auch die Eigenschaft “DBildImportArt=BilderMitMetadatenXML” erhalten.

In der Praxis sollte es somit nicht vorkommen, dass bei einem Import mit Metadaten-XML mehr als Bild zur externen ID mit Status “Original” und der Eigenschaft “DBildImportArt=BilderMitMetadatenXML” gefunden wird. Sollte es doch einmal vorkommen (z. B. da ein Bild von einem anderen System repliziert wurde oder der Status “Original” oder “DBildImportArt=BilderMitMetadatenXML” nachträglich gesetzt wurden), wird das Bild bzw. XML ins Fehler-Verzeichnis verschoben.

Maßgebliche DB-Tabellen

“DBild”

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "inbound" and space = "PPSD"
Include Page
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation
Disclaimer der PEIQ PRINT NGEN - Produktdokumentation

Nur für PEIQ-Mitarbeiter:innen

/wiki/spaces/CORE/pages/1050345477