Schnittstelle "onlinevhs.net"
Erstellt am: | Letzte Aktualisierung:
Die Schnittstelle "onlinevhs.net-Export" bietet Ihnen die Möglichkeit, Kursdaten aus cmxOrganize mit dem Portal onlinevhs.net auszutauschen. Sie kann auf onlinevhs.net neue Kurse anlegen sowie bereits angelegte Kurse aktualisieren oder stornieren. Der Datenabgleich kann entweder manuell oder per Automatismus angestoßen werden.
Um die Schnittstelle erstmalig einzurichten, gehen sie wie folgt vor:
- Öffnen Sie das Objekt "Schnittstellen"
- Klicken Sie auf die Methode "Schnittstelle erstellen"
- Klicken Sie in der Liste der Vorlagen auf "onlinevhs.net-Export"
- Damit die Schnittstelle genutzt werden kann, muss in der Eigenschaft "Passwort" Ihr API-token für den Datenaustausch eingetragen werden. Dieses bekommen Sie auf onlinevhs.net in Ihrem Benutzeraccount
- Um einen automatischen Datenabgleich zu machen, müssen die Attribute "Report" und "Intervall" ausgefüllt werden. Details dazu weiter unten in diesem Artikel.
Manueller Export zu onlinevhs.net:
Markieren Sie in der Spalte "Veranstaltung" eines Veranstaltungsreports alle Veranstaltungen die Sie abgleichen möchten und führen Sie dann unter dem Punkt "Optionen -> Export -> Schnittstellen" die Methode "onlinevhs.net" aus.
Veranstaltungen, die mit onlinevhs.net abgeglichen werden sollen, müssen folgende Bedingungen erfüllen::
- Status der Phase "Durchführung" oder Status "ausgefallen"
- Veranstaltungsende liegt in der Zukunft (beendete Veranstaltungen dürfen nicht mehr im Report erscheinen!)
Denken Sie bitte daran, dass ein Report nicht immer alle Ergebnisse anzeigt und Sie ggf. die Anzahl der pro Seite angezeigten Veranstaltungen entsprechend erhöhen müssen, um alle Veranstaltungen auswählen zu können.
Wir empfehlen Ihnen, für diesen Export einen neuen Report im Objekt "Veranstaltungen" zu erstellen und die beiden oben beschriebenen Punkte als Bedingungen zu hinterlegen. Falls Sie Unterstützung bei dem Aufbau eines solchen Reports machen, wenden Sie sich bitte an: support@cmxkonzepte.de.
Alternativ können Sie natürlich auch einen der Standardreports verwenden und dort die übertragungsfähigen Veranstaltungen über Filter in den Spalten "Phase", "Status" und Endedatum heraussuchen.
Automatischer Export (Zeitgesteuert):
Um einen automatischen, zeitgesteuerten Abgleich mit openvhs.net durchzuführen, benötigen Sie zwingend einen individuellen Report, der nur die die Veranstaltungen anzeigt, die die oben beschriebenen Kriterien erfüllt (Phase "Durchführung" oder Status "ausgefallen" + Ende liegt in der Zukunft).
Öffnen Sie die über die Zentrale Suche eine Auflistung der aktiven Schnittstellen und verwenden Sie die Eigenschaften "Report" und "Intervall" in der Schnittstelle "openvhs.net Export" um den Automatismus einzurichten.
Eigenschaft "Report"
Hier muss der Report verknüpft werden, der die abzugleichenden Veranstaltungen enthält (s. oben).
Eigenschaft "Intervall"
Mit dieser Eigenschaft steuern Sie, in welchem Zeitabstand (stündlich, täglich oder wöchentlich) ein automatischer Abgleich aller Veranstaltungen im verknüpften Report erfolgen soll.
Eigenschaft "Webadresse"
Für den automatischen Export muss „https://onlinevhs.net“ als URL hinterlegt werden.Für weitere Informationen zu den Schnittstellen und deren Einrichtung stehen wir Ihnen gerne zur Verfügung.