Definition Offline-Partner

Unter der Bezeichnung Offline-Partner verstehen wir Partner, die nicht über einen OXOMI-Account verfügen. Diese können Sie als Offline-Partner in OXOMI anlegen und per E-Mail oder per FTP-Upload ebenfalls mit Dokument- oder Video-Inhalten versorgen. Die Versorgung von videobasierten Inhalten ist nur per FTP-Upload möglich. Offline-Partner werden in der Verwaltungsoberfläche angelegt. Diese erreichen Sie über den Menüpunkt Partner der Navigationsleiste.

Hinweis: Sollten Sie diese Option nicht besitzen, muss diese Funktion für Ihren Account freigeschaltet werden. Wenden Sie sich in diesem Fall an unser Support-Team. Dieses erreichen Sie unter support@scireum.net / +49 (0)7151 90316-20 / Live support .

Erstellen und verwalten

Zum Erstellen eines neuen Offline-Partners muss zunächst der Typ gewählt werden. Die Zustellung neuer Inhalte kann per E-Mail oder per FTP-Upload erfolgen. Es werden zunächst die Angabe des Empfängers, also eines Ansprechpartners mit E-Mail-Adresse oder der Verbindungseinstellungen zu einem FTP-Server festgelegt. Zudem wählen Sie die gewünschten Filtereinstellungen aus, um gezielt nach Handelsstufe, Partnerrolle, Inhaltstyp, Inhaltssubtyp (Dokumententyp, Videotyp), Markenfilter, Kategorie, Tags, Sprache, Land nur bestimmte Inhalte zu versenden.

Jeder auf diese Weise eingetragene Offline-Partner bekommt für den von Ihnen definierten Umfang automatisiert neue Inhalte mitgeteilt bzw. übertragen. Wird ein bestehendes, bereits übermitteltes Dokument in OXOMI neu verarbeitet, so wird es erneut übermittelt.

Sollten Sie den automatisierten Versand nicht wünschen, können Sie den Versand innerhalb der Einstellungen des entsprechenden Offline-Partners deaktivieren.

Unter Benachrichtigungen können Sie sehen, wann und welche Inhalte an eine Offline-Partnerschaft versendet bzw. erfolgreich hochgeladen wurden. Bei per E-Mail versendeten Links zu Dokumenten wird zudem angezeigt, ob und wann die enthaltenen Links tatsächlich geöffnet und die Inhalte abgefragt wurden.

Details zur Übertragung

Ein Offline-Partner vom Typ E-Mail erhält maximal täglich eine E-Mail. Diese beinhaltet eine Auflistung aller von Ihnen freigegebenen Inhalte inklusive Download-Links. Der E-Mail-Empfänger kann in der E-Mail einen Link betätigen, der ihn abmeldet. Abgemeldete Empfänger sind in der Verwaltungsoberfläche entsprechend filterbar.

Beachten Sie jedoch bitte, dass der Offline-Partner vom Typ E-Mail ausschließlich Benachrichtigungen über Inhalte, die nach der Erstellung des Partners eingestellt wurden, erhält. Inhalte, die vor der Erstellung des Partners eingestellt wurden, werden nicht übermittelt.

Tipp: Bevor Sie Partner als Empfänger eintragen, empfiehlt sich ein Test mit Ihrer eigenen E-Mail-Adresse, um das Feature kennenzulernen. Der Versand der E-Mails erfolgt am Tag nach der letzten Änderung Ihrer Inhalte.

Ein Offline-Partner vom Typ FTP erhält maximal einmal täglich einen Upload für jeden veränderten Inhalt. Dabei wird zunächst die Inhalts-Datei (z.B. 12345.pdf, video-678.mp4) hochgeladen. Nachdem die Daten erfolgreich gespeichert wurden, wird eine JSON-Datei mit dazu passendem Dateinamen (z.B. 12345.json, video-678.json) übertragen.

Liegen Dateien gleichen Namens bereits im Verzeichnis, so werden diese überschrieben.

Im Rahmen der Versorgung mittels FTP-Upload kann außerdem die Benachrichtigung für Änderungen an den Metadaten eines Inhalts aktiviert werden. In diesem Fall wird bei jeder Änderung an den Metadaten eines Inhalts eine JSON-Datei mit den Metadaten des Inhalts an den FTP-Server übertragen. Diese JSON-Datei kann dann von Ihnen für die Weiterverarbeitung genutzt werden.

Wenn die Benachrichtigung für Änderungen an den Metadaten eines Inhalts aktiviert ist, wird außerdem eine Benachrichtigung ausgelöst, wenn der Inhalt gelöscht wird. In diesem Fall wird ebenso eine JSON-Datei mit gleichem Dateinamen hochgeladen. In diesem Fall enthält die JSON-Datei jedoch nur die Inhalts-ID, den Nachrichtentyp, den Inhaltstyp, den Inhaltsnamen sowie die JSON-Schema-Version.

Dokumentation der JSON-Datei

Im Folgenden finden Sie die Beschreibung der einzelnen Felder. Die Fett markierten Felder werden immer mit Inhalt übertragen. Die anderen Felder können leer sein. Dies hängt vom contentType, messageType und vom Inhalt selbst ab.

Feldname Beschreibung
id Enthält die Inhalts-ID.
version Enthält die Versionnummer des JSON-Schemas.
name Enthält die Bezeichnung des Inhalts.
contentType

Definiert die Art des Inhalts. Mögliche Werte sind:

  • DOCUMENT
  • VIDEO
messageType

Definiert die Art der Nachricht. Mögliche Werte sind:

  • NEW - Signalisiert, dass der Inhalt neu ist.
  • UPDATE - Signalisiert, dass der Inhalt aktualisiert worden ist.
  • METADATA_UPDATE - Signalisiert, dass sich die Metadaten des Inhalts geändert haben.
  • DELETED - Signalisiert, dass der Inhalt gelöscht worden ist.
fileName Enthält den Dateinamen.
contentState

Definiert den Status des Inhalts. Mögliche Werte sind:

  • OK - Signalisiert, dass der Inhalt aktiv ist.
  • ARCHIVED - Signalisiert, dass der Inhalt archiviert ist.
series Gibt die Serie an, die dem Inhalt zugeordnet ist.
brand Gibt die Marke an, die dem Inhalt zugeordnet ist.
tradeLevel

Gibt die Handelsstufe an, für die der Inhalt bestimmt ist. Die möglichen Werte sind:

  • WHOLESALE - Wholesale
  • RETAIL - Retail
  • END_CUSTOMER - End customer
validFrom Gibt das Anfangsdatum an, ab dem der Inhalt sichtbar sein soll. Wenn keine Angabe vorhanden ist, ist der Inhalt sofort verfügbar.
validUntil Gibt das Enddatum an, bis zu dem der Inhalt sichtbar sein soll. Wenn keine Angabe vorhanden ist, ist der Inhalt unbegrenzt verfügbar.
type

Definiert den Typ des Inhalts und hängt vom contentType ab. Die möglichen Werte sind:

description

Enthält eine abweichende Bezeichnung für den Inhalt. Falls vorhanden, kann diese Beschreibung in mehreren Sprachen angegeben sein, einschließlich des Standardtextes (default), der für unbekannte Sprachen zu verwenden ist.

languages

Enthält die im Inhalt verwendete(n) Sprache(n) als ISO-Code mit 2 Zeichen.

countries

Enthält die Länder, in denen der Inhalt gültig ist als ISO-Code mit 2 Zeichen. Wenn kein Land angegeben ist, hat der Inhalt keine Länderbeschränkung.

predecessor Enthält die Dokument-ID des Vorgängerdokuments, sofern der contentType den Wert DOCUMENT annimmt.
pageOffset

Enthält den Seitenversatz für das Dokument, sofern der contentType den Wert DOCUMENT annimmt. Beispiel: Ist die Dokumentenseite, auf der die Seitennummer „1“ aufgedruckt ist, auf der 3. Seite der PDF-Datei, so ist der Seitenversatz 2.

Beispiel JSON-Datei

Das folgende Beispiel zeigt eine JSON-Datei für den Fall das ein neues Dokument mit der ID „12345“ erstellt wurde. Die JSON-Felder sind für den Fall das der messageType den Wert UPDATE oder METADATA_UPDATE annimmt identisch.

{
     "id": "12345",
     "version": "2.0",
     "fileName": "12345.pdf",
     "name": "Beispieldokument-Name",
     "contentType": "DOCUMENT",
     "messageType": "NEW",
     "contentState": "OK",
     "series": "Beispiel-Serie",
     "brand": "Beispiel-Hersteller",
     "tradelevel": "END_CUSTOMER",
     "validFrom": "2022-01-01",
     "validUntil": "2022-12-31",
     "predecessor": "12321",
     "type": "catalog",
     "description": {
         "default": "Sample catalog",
         "de": "Beispielkatalog",
         "fr": "Exemple de catalogue"
     },
     "languages": ["de", "en", "fr"],
     "countries": ["de", "gb", "fr"],
     "pageOffset": 3
}

Das folgende Beispiel zeigt eine JSON-Datei für den Fall das der messageType den Wert DELETED annimmt.

{
     "id": "12345",
     "version": "2.0",
     "name": "Beispieldokument-Name",
     "contentType": "DOCUMENT",
     "messageType: "DELETED"
}