Schnittstelle "VhsCloud"
Diese Beschreibung dient als Hilfestellung zur Einrichtung der Schnittstelle "VhsCloud" in cmxOrganize. Sollten Sie einen bestimmten Abschnitt in diesem Artikel suchen, nutzen Sie bitte die Suchfunktion in Ihrem Browser.
Grundlegende Einrichtung
Damit die vhs.cloud über die Schnittstelle "VhsCloud" in cmxOrganize genutzt werden kann, benötigen Sie einen Cloud-Zugang. Hierzu müssen Sie Ihre VHS beim Deutschen Volkshochschul-Verband e.V. registrieren. Ist die Registrierung erfolgt, können Sie sich unter folgendem Link:
mit Ihren Login-Daten im Portal der vhs.cloud anmelden.
Login für die Schnittstelle in der vhs.cloud anlegen
Damit über die Schnittstelle zu Ihrem Verwaltungssystem Nutzer*innen und Kurse angelegt bzw. entfernt werden können, benötigen Sie einen vhs-Mitarbeiter-Zugang mit Administrator-Rechten für Ihre Volkshochschule in der vhs.cloud. Daher legen Sie mit Ihrem Zugang "administrator@..." in der Administration Ihrer vhs in der vhs.cloud ein gesondertes vhs-Mitarbeiter-Konto an. Dieses benötigt Administrations-Rechte auf der Ebene der vhs und wird ausschließlich für diesen Zweck genutzt.
Schnittstelle in cmxOrganize anlegen
Um die Schnittstelle "VhsCloud" (Bildungsportal) in cmxOrganize einzurichten, gehen Sie wie folgt vor:
- Klicken Sie auf Ihrer Startseite in das Suchfeld "Navigation" und geben Sie dort "Schnittstellen" ein und öffnen Sie das Objekt. Es wird Ihnen dann der Listenreport "Schnittstellen" des Objekts angezeigt.
- Klicken Sie im Report rechts neben der Methode "Schnittstelle erstellen" auf die 3 Punkte (...). Es wird das Fenster "Schnittstelle von Vorlage erstellen" angezeigt. Über das Feld "Vorlagen suchen..." suchen Sie dann die Vorlage "VhsCloud" und klicken Sie rechts auf den Button "erstellen". Im Anschluss sollten Sie die Detailseite der Schnittstelle sehen.
- Hier erweitern Sie den Bereich "Einrichtung". Im Anschluss tragen Sie dann beim Attribut "Benutzername" und beim Attribut "Passwort" die Daten ein, welche Sie zuvor auf der Seite vhs.cloud angelegt haben.
- Ist dies erledigt, öffnen Sie das Objekt "Einstellungen" auf der rechten Seite bei Objekte. Ist dieses nicht vorhanden, klicken Sie auf den Bereich "Objekte", sodass der Bearbeitungsmodus geöffnet wird. Über das Suchfeld "Objekte" suchen Sie nach dem Objekt "Einstellungen". Haben Sie es gefunden, klicken Sie auf den Button "Anheften". Ist dies erledigt, klicken Sie auf den Button "fertig" und öffnen Sie das Objekt "Einstellungen" indem Sie es anklicken.
- Ist die Detailseite der Einstellung geöffnet, klicken Sie auf die 3 Punkte rechts neben der Methode "Einstellung erstellen". Es wird das Fenster "Einstellung von Vorlage erstellen" angezeigt. Über das Feld "Vorlagen suchen..." suchen Sie dann die Vorlage "VHS-Login" und klicken Sie rechts auf den Button "erstellen". Im Anschluss wird die Einstellung aus der Vorlage erstellt und geöffnet.
- Auf der Dateiseite der Einstellung geben Sie unter dem Attribut "Wert" die Daten vom Deutschen Volkshochschul-Verband e.V. für Ihre Organisation übermittelten Benutzernamen (info@...) ein und speichern Sie die Eingabe im Anschluss durch Drücken der Enter-Taste.
Damit ist die Einrichtung der Schnittstelle abgeschlossen.
ACHTUNG:
- Haben Sie die Einrichtung abgeschlossen, so geben Sie uns anschließend eine kurze Information hierzu, damit wir bei Ihnen die Datenstruktur für die vhs.cloud anlegen können.
- Da bei der Nutzung der Schnittstelle, Daten aus cmxOrganize an die vhs.cloud übertragen werden, sollten Sie die Datenschutzhinweise auf Ihrer Homepage entsprechend anpassen.
Login-Daten des Teilnehmers und der Honorarkraft
Damit die Schnittstelle richtig arbeitet, ist es zwingend notwendig, dass bei allen Kontakten (Teilnehmer und Honorarkräfte) in cmxOrganize der entsprechende Login zu vhs.cloud hinterlegt ist.
Hat der Teilnehmer oder die Honorarkraft bereits einen eigenen Login zur vhs.cloud erstellt, so gehen Sie wie folgt vor, um den Benutzernamen im Kontakt zu hinterlegen:
- Im System findet man den Kontakt im Objekt "Kontakte". Hierzu klickt man auf der Startseite in das Feld "Navigation" oder greift auf das ggf. verknüpfte Objekt auf der Startseite zurück. Hat man das Objekt "Kontakte" geöffnet, wird der Listenreport des Objekts angezeigt. Suchen Sie betroffenen Kontakt über den Report und klicken Sie diesen an. Im Anschluss wird dessen Detailseite angezeigt.
- Auf der Detailseite des Kontakts klicken Sie rechts auf die Applikation "VhsCloud" im Bereich Applikationen. Ist diese nicht vorhanden, fügen Sie diese hinzu.
- Ist die Detailseite der Applikation geöffnet, gibt es das Attribut "Login". Klicken Sie hier auf die 3 Punkte, sodass eine Eingabe möglich ist (rote Umrandung), und geben Sie dort den Login des Kontakts für die vhs.cloud ein und drücken Sie Enter, um die Eingabe abzuschließen.
Hat der Teilnehmer/Honorarkraft noch keinen Login für die vhs.cloud, kann man diesen direkt über cmxOrganize anlegen. Die Voraussetzung hierfür ist, dass der Kontakt einen vollwertigen Zugang zum Internetauftritt Ihrer Webseite besitzt. Prüfen kann man dies im Kontakt wie folgt:
Sind die Voraussetzungen erfüllt, so gehen Sie wie folgt vor, um diesen im Kontakt in cmxOrganize anzulegen:
- Auf der Detailseite des Kontakts klicken Sie rechts auf die Applikation "VhsCloud" im Bereich Applikationen. Ist diese nicht vorhanden, fügen Sie diese hinzu.
- Ist die Detailseite der Applikation geöffnet, gibt es dort die Methode "Benutzer anlegen". Klicken Sie darauf und bestätigen Sie dann die Sicherheitsabfrage mit "OK". Im Anschluss generiert die Schnittstelle zur vhs.cloud einen Benutzer-Login für den Kontakt. Sollten Daten zur Erstellung fehlen, so wird eine entsprechende Fehlermeldung angezeigt.
Wurde der Zugang für die vhs.cloud über die Methode "Benutzer anlegen" angelegt, so lautet der Benutzer-Login dann wie folgt: VornameName@vhs.cloud
Achtung: Die Übertragung erfolgt einmalig zu dem Zeitpunkt, zu dem Sie den Benutzer-Login für die vhs.cloud anlegen. Spätere Änderungen im Kontakt werden nicht übertragen. Falls der Kontakt schon einen Zugang auf der vhs.cloud hat, wird ein weiterer Benutzer-Login angelegt. Ist im Kontakt beim Internetauftritt beim Attribut "Passwort" kein korrektes Passwort hinterlegt oder unter der Methode "Passwort ändern" der rote Schriftzug "noch kein Passwort" übersehen, wird beim Anlegen des neuen Benutzers für die vhs.cloud eine entsprechende Fehlermeldung angezeigt (Anlegen des Benutzers nicht möglich. Zugangsdaten zum Internetauftritt müssen vorhanden sein.).
Datenschutzhinweis:
Bei der Verwendung der VhsCloud Schnittstelle werden beim Ausführen der Methode „Benutzer anlegen“ die folgenden personenbezogenen Daten aus dem cmxOrganize-Kontakt an die vhs.cloud übertragen.
- Name
- Vorname
- Namenspräfix
- E-Mail-Adresse aus dem Attribut "Benutzername/E-Mailadresse“
Bitte implementieren Sie diese Information im Objekt „Internetauftritt“ im Text der Eigenschaft Information EU-DSGVO Anmeldung.Hinweis: Die Übertragung erfolgt einmalig zu dem Zeitpunkt, zu dem Sie den Benutzer anlegen. Spätere Änderungen im Kontakt werden nicht übertragen. Falls der Kontakt schon einen Zugang auf der vhs.cloud hat, wird ein weiterer Benutzer-Login angelegt.
Wichtige Informationen zum Initial-Passwort bei einem neu angelegten vhs.cloud-Zugang
Beim Erstlogin des Kontakts in der vhs.cloud mit seinem neuen Benutzer-Login verwendet dieser dasselbe Passwort wie beim Login im Internetauftritt. Dieses wird per API von der vhs.cloud von cmxOrganize abgefragt. Im Anschluss kann der Kontakt ein eigenes neues Passwort auf der Webseite vhs.cloud vergeben.
Hinweis: Wenn der Kontakt das Passwort zum Zugang des Internetauftritts nicht mehr weiß, kann er dieses über die Funktion "Passwort vergessen" im Internetauftritt auf der Loginseite zurücksetzen. Alternativ kann ein Mitarbeiter im Kontakt die Methode "Passwort-Rücksetz-Link senden" ausführen. Der Kontakt bekommt daraufhin eine E-Mail mit einem Link zum Zurücksetzen des Passworts, welcher eine Gültigkeit von 4 Stunden hat.
Löschen eines Benutzer-Logins für die vhs.cloud
Über cmxOrganize ist es nicht möglich, einen Benutzer-Login auf der vhs.cloud zu löschen. Ist das der Wunsch eines Benutzers, so muss dieser direkt auf der vhs.cloud-Webseite eine Löschung beantragen oder durchführen.
Veranstaltung übertragen / Kurs anlegen
Rufen Sie zuerst die Veranstaltung auf, welche Sie an die vhs.cloud übertragen möchten. Im Anschluss gehen Sie wie folgt vor:
- Klicken Sie auf der Detailseite der Veranstaltung im Bereich "Applikationen" (rechte Seite) auf die Applikation "VhsCloud". Ist diese nicht vorhanden, fügen Sie diese hinzu.
- Auf der Detailseite der Applikation, klicken Sie dann auf die Methode "Kurs anlegen".
- Bestätigen Sie im Anschluss die Sicherheitsabfrage mit "ok". Nun erscheint ein Dialog mit der Statusmeldung
- Anlegen des Kurses erfolgreich.
- Hinzufügen des Kurleiters Vorname Name erfolgreich.
Honorarkräfte (in der vhs.cloud Kursleiter genannt) werden bei „Anlegen des Kurses“ automatisch zusammen mit der Veranstaltung übertragen, sofern im Kontakt der Honorarkraft ein vhs.cloud Login verknüpft ist. Teilnehmer nur dann, wenn der Veranstaltungsbeginn schon erreicht ist. Ist eine Honorarkraft bereits angemeldet, wird darauf im Dialog hingewiesen.
Der Kurscode wird automatisch generiert und beim Attribut "Kurscode" in der Applikation hinterlegt. Der erste Teil vom Kurscode vor dem @ ist dynamisch und setzt sich aus der Kursnummer, dem Titel und den letzten vier Zeichen des Autowertes (URL der Veranstaltung) zusammen.
Beispiel: vc00001-testkursanpz2-85c@cmxkonzepte.vhs.cloud
Honorarkräfte nachträglich übertragen
Es kann vorkommen, dass zum Zeitpunkt der Übertragung der Veranstaltung an die vhs.cloud, in dieser noch keine Honorarkraft geplant / hinterlegt war oder eine Honorarkraft im Nachhinein in der Veranstaltung ausgetauscht wurde. In diesem Fall können Sie wie folgt vorgehen, um diese nachträglich zu übertragen:
1.) Öffnen Sie die Veranstaltung, in welcher Sie die Änderung bei der Honorarkraft nachträglich an die vhs.cloud übertragen wollen.
2.) Wird Ihnen die Detailseite der Veranstaltung angezeigt, öffnen Sie die Applikation "VhsCloud" (rechts im Bereich "Applikationen").
3.) In der Applikation gibt es die Methode "Alle Teilnehmer und Kursleiter übertragen". Durch Klick auf diese Methode können nach gepflegte oder geänderte Honorarkräfte an die vhs.cloud übertragen werden. Bestätigen Sie die Sicherheitsanfrage mit OK. Im Anschluss wird eine Statusmeldung in der Applikation angezeigt.
Durch Ausführen der Methode wird die aktuelle Honorarkraft an die vhs.cloud übertragen.
Hinweis: Wurde die Veranstaltung inkl. Honorarkraft schon an die vhs.cloud übertragen und die Honorarkraft im Nachhinein ausgetauscht, so wird nur die neue Honorarkraft übertragen. Die vorherige Honorarkraft können Sie nur in der vhs.cloud löschen (sollte dies notwendig sein).
Teilnehmer zur Veranstaltung (Kurs) anmelden
Wird in einer bereits gemeldeten Veranstaltung eine neue Anmeldung für einen Teilnehmer mit dem Status "Anmeldung" erstellt, wird diese automatisch an die vhs.cloud übertragen, solange im Kontakt die Logindaten zur vhs.cloud hinterlegt sind.
Wenn die Methode „Alle Teilnehmer und Kursleiter übertragen“ in der Applikation "VhsCloud" in der gemeldeten Veranstaltung ausgeführt wird, obwohl die Teilnehmer bzw. Honorarkräfte schon übertragen wurden, passiert nichts. Es erscheint lediglich eine entsprechende Hinweismeldung in der Applikation. Fehlen entsprechende Daten um den Teilnehmer zu übertragen, wird dies ebenfalls angezeigt.
Teilnehmer aus Veranstaltungen (Kurs) löschen
Wird in cmxOrganize die Anmeldung eines Teilnehmers in einer Veranstaltung storniert, welche an die vhs.cloud gemeldet wurde, wird der Teilnehmer automatisch aus dem Kurs bei der vhs.cloud entfernt.
Veranstaltungen (Kurs) aus der vhs.cloud löschen
Um eine gemeldete Veranstaltung aus der vhs.cloud zu löschen, öffnen Sie die Veranstaltung in cmxOrganize. Auf der Detailseite der Veranstaltung klicken Sie auf die Applikation "VhsCloud" (rechts im Bereich "Applikationen").
Im Anschluss reicht ein Klick auf die Methode "Kurs löschen" sowie eine Bestätigung der Sicherheitsabfrage auf "ok" die gemeldete Veranstaltung aus der vhs.cloud zu entfernen. War alles erfolgreich, wird eine entsprechende Hinweismeldung in der Applikation angezeigt.
Meldungen in der Applikation "vhs.cloud" interpretieren und verarbeiten
Es wurden keine Honorarkräfte übertragen
Die folgende Meldung erscheint, wenn mit der Veranstaltung kein Honorarvertrag verknüpft ist.
Lösung: Bitte hinterlegen Sie in der Veranstaltung den entsprechenden Honorarvertrag. Anschließend wählen Sie in der Veranstaltung erneut die Applikation „VhsCloud“ und „Alle Teilnehmer und Kursleiter der Veranstaltung (Kurs) übertragen“.
Der Kursleiter (Vorname) (Name) hat keinen Login zur vhs.cloud
Die folgende Meldung erscheint, wenn im Kontakt der Honorarkraft noch kein Login zur vhs.cloud hinterlegt ist.
Lösung: Bitte legen Sie im Kontakt der Honorarkraft einen vhs.cloud Login an.
- Der Teilnehmer (Vorname) (Name) hat keinen Login zur vhs.cloud
Die folgende Fehlermeldung erscheint, wenn der Kontakt des Teilnehmers noch keinen Zugang Login zur vhs.cloud besitzt.
Lösung: Bitte legen Sie im Kontakt des Teilnehmers einen vhs.cloud Login an.