Konfiguration

Erstellen Sie im Haupt- oder einem übergeordneten Verzeichnis Ihrer zu synchronisierenden Inhalte die Datei oxomi.conf. Füllen Sie diese anschließend mit folgendem Inhalt und passen Sie die vordefinierten Werte entsprechend der dazugehörigen Kommentare an. Falls Sie Fragen zu der Notation haben, finden Sie  Details (HOCON-Format) auf der verknüpften Seite.

# ACHTUNG wichtiger Hinweis:
# Entfernen Sie NICHT die "-Zeichen
 
# Enthält die OXOMI Benutzerdaten
oxomi {
    # Geben Sie hier den Username des Mandanten an
    user = "username"
    # Geben Sie hier den API Token des Mandanten an (unter 'Mein Profil')
    token = "TOKEN"
}
 
# Geben Sie hier den vorzunehmenden Vorgang an
# (media, document, video, media-sync, document-sync, video-sync oder bmecat-import)
task = TASK
 
# Geben Sie hier den Unterordner für die Synchronisation oder
# Pfad + Dateiname bei Einzelaufruf an
# Dieser ist immer relativ zum Speicherort dieser oxomi.conf Datei.
filePath = "test/"
 
# Geben Sie hier eventuelle Zusatzmodi für den aktuellen Vorgang an
# mode = MODE
 
# Enthält Daten für den Import oder die Synchronisation von Dokumenten
document {
    # Sollen Dokumente an Partner weitergegeben werden?
    forwarding = false

    # Sollen lokal gelöschte Kataloge in OXOMI gelöscht oder
    # archiviert werden?
    deleteOld = false

    # In OXOMI angezeigter Name der Dokumente
    publicName = "name"

    # Marke der Dokumente
    brandName = "marke"

    # Handelsstufe der Dokumente (END_CUSTOMER, RETAIL od. WHOLESALE)
    targetLevel = RETAIL

    # Dokumententyp
    type = catalog
}

# Enthält Daten für den Import oder die Synchronisation von Dokumenten
video {
    # Sollen Videos an Partner weitergegeben werden?
    forwarding = false

    # Sollen lokal gelöschte Videos in OXOMI gelöscht oder
    # archiviert werden?
    deleteOld = false

    # In OXOMI angezeigter Name der Videos
    publicName = "name"
        
    # Beschreibungstext
    description = "Dies ist eine Beschreibung."

    # Marke der Videos
    brandName = "marke"

    # Handelsstufe der Videos (END_CUSTOMER, RETAIL od. WHOLESALE)
    targetLevel = RETAIL

    # Videotyp
    type = webtv
}

# Enthält Daten für den Import von BMEcat-Dateien
bmecat {
    # Länder der artikelbezogenen Daten
    countries = ["de", "ch"]

    # Sprache der artikelbezogenen Daten
    lang = "de"

    # Präfix der Dateien im Medien-Pool
    prefix = "/mmedia"

    # XML-Datei nach dem Job löschen?
    deleteFile = true

    # Sollen Videos auch eingelesen werden?
    readVideos = true

    # Handelsstufe der Videos (WHOLESALE, RETAIL oder END_CUSTOMER)
    levelVideos = WHOLESALE

    # Sollen Explosionszeichnungen auch eingelesen werden?
    readExplosions = true

    # Handelsstufe der Explosionszeichnungs-Exposés (WHOLESALE, RETAIL oder END_CUSTOMER)
    levelExplosions = WHOLESALE
}

Um die Konfiguration Ihren Wünschen und Ihrem Einsatzzweck anzupassen, nutzen Sie die nachfolgend beschriebenen Parameter. Wir unterscheiden zwischen notwendigen und zusätzlichen Parametern.

Pflichtparameter

Parameter Beschreibung
oxomi.user

Der Loginname des OXOMI Benutzers, für den Dokumente oder Medien-Dateien importiert werden sollen.

oxomi.token

Der API Token des OXOMI Benutzers. Diesen Wert finden Sie in OXOMI im Bereich Mein Profil im Admin-Menü von OXOMI.

filePath

Dieser Parameter gibt bei Einzeldatei-Vorgängen den kompletten Pfad inklusive Dateiname und bei Synchronisierungs-Vorgängen den Pfad zum abzugleichenden Ordner, jeweils relativ zum Pfad der Konfigurationsdatei, an.

task

Der Vorgang, der vom Import-Tool durchgeführt werden soll. Hierfür haben Sie folgende vier Möglichkeiten:

Wert Beschreibung
media Eine einzelne Datei in den Medien-Pool von OXOMI importieren
document Ein einzelnes Dokument in OXOMI importieren
video Ein einzelnes Video in OXOMI importieren
media-sync Die Medien-Dateien eines gesamten Verzeichnisses mit OXOMI abgleichen
document-sync Die Dokumente eines gesamten Verzeichnisses mit OXOMI abgleichen
video-sync Die Videos eines gesamten Verzeichnisses mit OXOMI abgleichen
bmecat-import Eine BMEcat-XML-Datei in OXOMI importieren

Dokumente

Sollten Sie  Dokumente mit dem Tool synchronisieren wollen, sind die nachfolgenden Konfigurationswerte notwendig.

Parameter Beschreibung
document.forwading

Gibt an, ob die Dokumente an Partner weitergeleitet werden sollen. Wenn der Wert auf true steht, wird weitergeleitet. Wenn dieser false ist, dann nicht.

document.targetLevel

Bestimmt die Handelsstufe, für die die Dokumente sichtbar sein sollen. Folgende Werte sind möglich

Wert Beschreibung
WHOLESALE Nur für den Großhandel sichtbar.
RETAIL Sowohl für den Einzel- als auch für den Großhandel sichtbar.
END_CUSTOMER Für Großhandel, Einzelhandel und Endkunden sichtbar.

Mehr Informationen zu der Funktionsweise von  Handelsstufen finden Sie auf der verlinkten Seite.

Videos

Sollten Sie  Videos mit dem Tool synchronisieren wollen, sind die nachfolgenden Konfigurationswerte notwendig.

Parameter Beschreibung
video.forwading

Gibt an, ob die Videos an Partner weitergeleitet werden sollen. Wenn der Wert auf true steht, wird weitergeleitet. Wenn dieser false ist, dann nicht.

video.targetLevel

Bestimmt die Handelsstufe, für die die Videos sichtbar sein sollen. Folgende Werte sind möglich

Wert Beschreibung
WHOLESALE Nur für den Großhandel sichtbar.
RETAIL Sowohl für den Einzel- als auch für den Großhandel sichtbar.
END_CUSTOMER Für Großhandel, Einzelhandel und Endkunden sichtbar.

Mehr Informationen zu der Funktionsweise von  Handelsstufen finden Sie auf der verlinkten Seite.

Zusatzparameter

Parameter Beschreibung
server.host

Die Komplette OXOMI URL inklusive Protokoll.

Druch Angabe dieses Parameters können Sie den Standardwert von https://oxomi.com überschreiben.

server.port

Der Port über den mit OXOMI kommuniziert wird.

Druch Angabe dieses Parameters können Sie den Standardwert von 443 überschreiben.

mode

Definiert einen zusätzlichen Modus.

Durch Angabe dieses Parameters und einem der im folgenden genannten Parameter können Sie die Ausführung des festgelegten Vorgangs ("task-Pflichtparameter") beeinflussen.

Wert Beschreibung
force Ignoriert bei Synchronisierungs-Vorgängen (z.B. "media-sync") die History der letzten Synchronisation, wodurch eine erneute vollständige Synchronisierung erzwungen wird.

Dokumente

Sollten Sie  Dokumente mit dem Tool synchronisieren wollen, sind die nachfolgenden Konfigurationswerte möglich.

Hinweis: Die Parameter in der nachfolgenden Tabelle machen nur im Fall einer einzelnen Dokument-Synchronisierung Sinn.

Parameter Beschreibung
document.publicName

Bestimmt den in OXOMI angezeigten Namen für das Dokument.

Wird weder ein publicName noch ein internalName gesetzt, wird automatisch ein passender Name aus dem Dateinamen der Dokument-Datei gebildet.

document.internalName

Sollten Sie zwei Bezeichnungen für ein Dokument verwenden wollen, definieren Sie mit diesem Parameter eine nur intern sichtbare Bezeichnung. Der Parameter publicName wird dann zur veröffentlichten Bezeichnung.

document.code

Ergänzend zur ID des Dokuments können Sie hier einen Code vergeben, über den Sie das Element gezielt ansprechen können.

document.brandName

Name der Marke, unter der die Dokumente veröffentlicht werden.

document.brand

Kann als Alternative zu dem Parameter document.brandName benutzt werden. In diesem Fall wird dann eine Marken-ID als Wert definiert.

document.category

Definiert eine Kategorie für das synchronisierte Dokument.

document.type

Definiert den Dokument-Typ.

document.validDateFrom

Definiert ein Datum, ab wann das Dokument sichtbar ist.

Eine solche Angabe könnte so aussehen: "22.07.2015"

document.validDateUntil

Definiert ein Datum, bis wann das Dokument sichtbar ist.

Eine solche Angabe könnte so aussehen: "22.07.2015"

document.partnerRole

Definiert eine Partnerrolle für das Dokument.

document.locale_countries

Definiert, für welche Länder dieses Dokument verfügbar ist. Der Wert ist eine kommaseparierte Liste von  Länderkürzeln.

Eine solche Liste könnte beispielsweise so aussehen: ["de", "at"]

document.locale_lang

Definiert, für welche Sprache dieses Dokument verfügbar ist. Der Wert ist ein  Sprachkürzel.

Dokument-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Dokument-Typen und die dazugehörigen Codes für die Verwendung in der Konfiguration des Import-Tools:

Typ
Code
Beschreibung
Aktion
promotion
Aktionen sind zeitlich begrenzte Dokumente welche mit Preisen versehen sind. Für Sie gelten die gleichen Vorgaben wie bei Preislisten.
Katalog
catalog
Der Katalog ist eine Übersicht über die Produkte eines Anbieters. Ein Katalog kann Preise enthalten, jedoch nur Preise, welche allgemein bekannt sein dürfen.
Preisliste
pricelist
Die Preisliste enthält Preisinformationen zu Produkten. Dies können sowohl Händlerpreise, als auch Bruttolistenpreise sein. Einen Unterscheidung findet über die Handelsstufe statt.
Ersatzteile
spareparts
Ersatzteil-Dokumente sind spezielle Kataloge, welche vornehmlich Ersatzteile enthalten. Sofern es zu dem Katalog eine Ersatzteilpreisliste gibt, ist diese als Preisliste zu klassifizieren.
Prospekt
flyer
Ein Prospekt bietet Informationen über einen Teilbereich des Sortiments. Ein Prospekt kann Preise enthalten, jedoch nur Preise, welche allgemein bekannt sein dürfen.
Handbuch
manual
Handbücher bieten weiterführende Informationen zur Verwendung von Produkten. Hierunter fallen auch Betriebsanleitungen und Montageanleitungen.
Datenblatt
datasheet
Datenblätter umfassen technische Details zu Produkten. Dabei kann es sich um einzelne Datenblätter (je Produkt) oder auch um Sammlungen von Datenblättern (mehrere Produkte) handeln. Hierunter fallen: Sicherheitsdatenblätter, Werkszeugnisse.
Zertifikat
certificate
Zertifikate sind Dokumente, die geprüfte Eigenschaften eines oder mehrerer Produkte dokumentieren. Hierzu zählen unter anderem: Zulassungen, Gütesiegel, Normen.
Werkszeugnis
factory_certificate
Bescheinigung, in welcher der Hersteller bestätigt, dass die gelieferten Erzeugnisse den Vereinbarungen bei der Bestellung entsprechen, mit Angabe von Prüfergebnissen auf der Grundlage nichtspezifischer Prüfung.
Sicherheitsdatenblatt
material_safety_data_sheet
Sicherheitsdatenblätter (auch: Material Safety Data Sheets) bestehen hauptsächlich aus Sicherheitshinweisen für den Umgang mit gefährlichen Substanzen. Sicherheitsdatenblätter müssen vom Inverkehrbringer, Einführer und Hersteller von Gefahrstoffen zur Verfügung gestellt werden.
Anleitung
instruction
Anleitungen umfassen Betriebs- und Serviceanleitungen.
Technische Information
technical_information
Eine technische Information beschreibt die technischen und physikalischen Eigenschaften und den Anwendungsbereich von Produkten und Systemen. Sie enthält außerdem Vorgaben zur sicheren und fachgerechten Verarbeitung, Montage und Planung.
Leistungserklärung
declaration_of_performance
Mit der Leistungserklärung gemäß Bauprodukte-Verordnung (BauPVO) übernimmt der Hersteller die Verantwortung für die Übereinstimmung des Bauprodukts mit der erklärten Leistung in Bezug auf dessen wesentliche Merkmale.
Präsentation
presentation
Enthält eine Präsentation oder einen Foliensatz zu einem Produkt oder Thema.
Sonstiges
other
Verwenden Sie diesen Typ für alle Dokumente, für die kein anderer Typ passend erscheint.

Videos

Sollten Sie  Videos mit dem Tool synchronisieren wollen, sind die nachfolgenden Konfigurationswerte möglich.

Hinweis: Die Parameter in der nachfolgenden Tabelle machen nur im Fall einer einzelnen Video-Synchronisierung Sinn.

Parameter Beschreibung
video.publicName

Bestimmt den in OXOMI angezeigten Namen für das Video.

Wird weder ein publicName noch ein internalName gesetzt, wird automatisch ein passender Name aus dem Dateinamen der Video-Datei gebildet.

video.internalName

Sollten Sie zwei Bezeichnungen für ein Video verwenden wollen, definieren Sie mit diesem Parameter eine nur intern sichtbare Bezeichnung. Der Parameter publicName wird dann zur veröffentlichten Bezeichnung.

video.description

Hier kann ein Text, der als Beschreibung für das Video benutzt wird, angegeben werden.

video.code

Ergänzend zur ID des Videos können Sie hier einen Code vergeben, über den Sie das Element gezielt ansprechen können.

video.brandName

Name der Marke, unter der die Videos veröffentlicht werden.

video.brand

Kann als Alternative zu dem Parameter video.brandName benutzt werden. In diesem Fall wird dann eine Marken-ID als Wert definiert.

video.category

Definiert eine Kategorie für das synchronisierte Video.

video.type

Definiert den Video-Typ.

video.validDateFrom

Definiert ein Datum, ab wann das Video sichtbar ist.

Eine solche Angabe könnte so aussehen: "22.07.2015"

video.validDateUntil

Definiert ein Datum, bis wann das Video sichtbar ist.

Eine solche Angabe könnte so aussehen: "22.07.2015"

video.partnerRole

Definiert eine Partnerrolle für das Video.

video.locale_countries

Definiert, für welche Länder dieses Video verfügbar ist. Der Wert ist eine kommaseparierte Liste von  Länderkürzeln.

video.locale_lang

Definiert, für welche Sprache dieses Video verfügbar ist. Der Wert ist ein  Sprachkürzel.

Video-Typen

Die nachfolgendende Liste zeigt alle verfügbaren Video-Typen und die dazugehörigen Codes für die Verwendung in der Konfiguration des Import-Tools:

Typ
Code
Beschreibung
Produktvideo
product
Zeigt das referenzierte Produkt. Dies ist der Standard-Typ für Videos.
Anwendungsvideo
usage
Zeigt eine Anwendungsmöglichkeit des referenzierten Produkts.
Schulungsvideo
training
Erklärt den Umgang oder die Verwendung eines oder mehrerer Produkte.
Imagevideo
image
Präsentiert das Unternehmen, eine Marke oder einen Fachbereich.
WebTV
webtv
Ein journalistischer Beitrag mit Brancheninformationen.
Q&A Video
qa
Weiterbildung, Information oder Antwort auf eine konkrete Frage.

BMEcat

Sollten Sie  BMEcat-Dateien mit dem Tool importieren wollen, sind die nachfolgenden Konfigurationswerte möglich.

Parameter Beschreibung
bmecat.countries

Bestimmt die Länder, die allen Objekten (Artikeln, Langtexten, ...) zugewiesen werden, die mit diesem BMEcat importiert werden.

Standardwert: alle Länder

bmecat.lang

Bestimmt die Sprache, die allen Objekten (Artikeln, Langtexten, ...) zugewiesen wird, die mit diesem BMEcat importiert werden.

Standardwert: die Sprache des Unternehmens

bmecat.prefix

Falls vorhanden, wird dieser Präfix an den Anfang jedes Dateipfades gehängt, bevor die entsprechende Datei im Medien-Pool gesucht wird.

bmecat.deleteFile

Soll die hochgeladene XML-Datei nach Vollendung des Jobs automatisch wieder gelöscht werden?

Standardwert: false

bmecat.readVideos

Sollen Videos auch eingelesen werden?

Standardwert: false

bmecat.levelVideos

Bestimmt die Handelsstufe, die die eingelesenen Videos erhalten sollen. Nur relevant, wenn bmecat.readVideos = true.

mögliche Werte: WHOLESALE (Großhandel), RETAIL (Einzelhandel) und END_CUSTOMER (Endkunde)

Standardwert: WHOLESALE

bmecat.readExplosions

Sollen Explosionszeichnungen als Exposés eingelesen werden?

Standardwert: false

bmecat.levelExplosions

Bestimmt die Handelsstufe, die die eingelesenen Explosionszeichnungen erhalten sollen. Nur relevant, wenn bmecat.readExplosions = true.

mögliche Werte: WHOLESALE (Großhandel), RETAIL (Einzelhandel) und END_CUSTOMER (Endkunde)

Standardwert: WHOLESALE

Nächster Schritt

Fahren Sie mit der  Bedienung fort, um unter Anderem zu erfahren, wie Sie das Integrations-Tool starten und benutzen.