Deeplinks ermöglichen es Ihnen, dass Avendoo®-Inhalte als externer Link bereitgestellt werden können. Je nach Konfiguration des Systems wird der Benutzer nach Authentifizierung (Login, SSO, SAML u.a.) zum Inhalt umgeleitet. Insgesamt stehen Ihnen neun Deeplink-Typen zur Verfügung.
Inhalte
- 1 Deeplink der Kursfreigabe oder/und IDs suchen
- 2 Deeplinks ins Frontend (type 207)
- 3 Kursfreigabe und Trainingpläne (type 41 und type 84)
- 4 Ort-Ansicht (type 116)
- 5 Community-Nachrichten (type 136)
- 6 OB3 (type 165)
- 7 Cockpit (type 200)
- 8 Cockpit Mitarbeiteransicht (type 201)
- 9 Katalog (type 202)
- 10 Berichtsaufruf (type 203)
- 11 Deeplink und SSO
Deeplink der Kursfreigabe oder/und IDs suchen
-
- Wählen Sie Kursmanagement -> Kursfreigabe.
- Wählen Sie den Menüpunkt Informationen im Kontextmenü zum Titel der jeweiligen Kursfreigabe.
- Nun haben Sie zwei Möglichkeiten:
- Wählen Sie den Reiter Allgemein. Hier finden Sie in der Zeile Deeplink den Deeplink für die Kursfreigabe.
- Wenn Sie auf ein spezielles Lernobjekt in der Kursfreigabe verlinken möchten, wählen Sie den Reiter IDs. Hier finden Sie die IDs der in der Kursfreigabe verwendeten Lernobjekte. Wählen Sie die entsprechende ID aus und folgen Sie der Anleitung unter „Kursfreigabe und Trainingspläne“.
Deeplinks ins Frontend (type 207)
Es besteht die Möglichkeit, direkte Links (Deeplinks) zu bestimmten Bereichen im Frontend zu erstellen. Diese Links können z. B. in E-Mails, Widgets, Infoboxen oder auf externen Seiten verwendet werden, um Benutzer gezielt auf eine bestimmte Ansicht zu leiten.
Das folgende Beispiel zeigt, wie ein solcher Deeplink aufgebaut sein kann, um direkt zu Meine Erfolge des angemeldeten Benutzers zu führen. Dieser Deeplink kann z. B. in einer Systemmail eingesetzt werden.
Verwenden Sie folgenden Aufbau für den Deeplink: $SystemUrl$/d/link?type=207&route=success%2Fachievements
Erklärung der Parameter:
-
$SystemUrl$ist der Platzhalter für Ihre konkrete System-URL (z. B.https://portal.ihrsystem.de) -
type=207ist erforderlich, um Inhalte aufzurufen -
route=success%2Fachievementsverweist auf die Seite Meine Erfolge – wichtig: URL-encoded
Hinweis: Bitte achten Sie darauf, dass alle Schrägstriche / innerhalb des Parameters route= durch %2F ersetzt werden. Dies ist notwendig, damit die URL technisch korrekt übergeben wird. Die Route bezieht sich auf den Pfad hinter /ui/index#/ in der Benutzeroberfläche.
Beispiele für korrekte URL-Codierung:
| Ursprünglich | URL-encoded |
|---|---|
learnplace/my-content |
learnplace%2Fmy-content |
success/achievements |
success%2Fachievements |
Beispiel-Deeplink
Ein fertiger Deeplink zur Seite „Meine Erfolge“ könnte so aussehen: https://portal.ihrsystem.de/d/link?type=207&route=success%2Fachievements
Wenn ein Benutzer diesen Link aufruft – beispielsweise über einen Button, ein E-Mail-Template oder ein Info-Feld – wird er direkt zur entsprechenden Seite weitergeleitet.
Kursfreigabe und Trainingpläne (type 41 und type 84)
Die Deeplinks für die Kursfreigaben und Trainingpläne gibt es in zwei Varianten:
- Der Link wird mit Java-Script in einem neuen Fenster geöffnet und beim Verlassen des Kurses wird der Benutzer abgemeldet und das Fenster geschlossen.
- Der Link wird vom Benutzer eingegeben und beim Verlassen des Kurses wird der Benutzer abgemeldet und auf eine Logout-Seite weiter geleitet.
Der Deeplink kann zusätzlich einen Sprachparameter beinhalten, der bewirkt, dass der entsprechende Lerninhalt in der angegebenen Sprache geöffnet wird. Beispiel: https://avendooURLeinfügen.de/d/link?longId=HierIDEinsetzen&type=41&lang=de
Wenn Sie auf ein Kursobjekt oder Lerneinheit, z.B. Web-Based Training verweisen möchten, müssen Sie nach der longId die ObjectId mit einem Doppelpunkt hinzufügen. Beispiel: https://avendooURLeinfügen.de/d/link?longId=HierIDEinsetzen:ObjectId&type=41&lang=de
Beispiel für einen Deeplink zu einem Lernobjekt: http://Serveradresse/d/link?longId=KursfreigabenID,1:LernobjektID,1&type=41
Ort-Ansicht (type 116)
Weiterhin stehen Ihnen Deeplinks zur Verfügung, um eine Ortansicht zu öffnen.
Beispiel: https://avendooURLeinfügen.de/d/link?longId=1474273182099_1: 1473660084849_1:0_0:14744337819569_1&type=116
Die LongId setzt sich dabei zusammen aus:
- Assignment-Uid
- Standort-Uid
- Raum-Uid (Wenn kein Standort in der URL enthalten ist, wird 0_0 als Platzhalter genutzt)
- Termin-Uid
Community-Nachrichten (type 136)
Die Deeplinks für die Community-Nachrichten leiten den Benutzer entweder in den Benutzer-Community-Bereich oder Autoren-Community-Bereich.
In den „Systemeinstellungen“ im Admin-Bereich können Sie über die System-Property „community.email.link.destination.view“ konfigurieren, ob im Falle von „Kurscommunity“, „Lerngruppen“ und „Privaten Nachrichten“ auf den Reiter „Community“ einer Kursfreigabe oder zur allgemeinen Community-Seite gesprungen werden soll.
Beispiel: https://avendooURLeinfügen.de/d/link?messageId=HierIDEinsetzen&type=136
OB3 (type 165)
Cockpit (type 200)
Dieser Deeplink leitet den Benutzer in das Cockpit, wenn dieser ein Teamleiter ist.
Beispiel: https://avendooURLeinfügen.de/d/link?type=200
Cockpit Mitarbeiteransicht (type 201)
Dieser Deeplink leitet den Benutzer in das Cockpit und öffnet das Mitarbeiter-Popup.
Beispiel: https://avendooURLeinfügen.de/d/link?type=201&user=LOGIN&qExtRef=VALUE&action=addLearnunit
Der User-Parameter beinhaltet das Login des Benutzers, für den die Mitarbeiteransicht angezeigt werden soll.
Durch den qExtRef-Parameter werden alle Qualifikationswerte mit der entsprechenden Externen Referenz als Filter auf der Seite ausgewählt.
Der optionale Action-Parameter addLearnunit veranlasst, dass in der Mitarbeiteransicht der Bereich „Um weitere Lerninhalte hinzuzufügen“ angezeigt wird.
Katalog (type 202)
Dieser Deeplink leitet den Benutzer in den Katalog, wobei der qExtRef-Parameter alle Qualifikationswerte mit der entsprechenden Referenz als Filter auf der Seite auswählt.
Beispiel: https://avendooURLeinfügen.de/d/link?type=202&qExtRef=VALUE
Berichtsaufruf (type 203)
Dieser Deeplink leitet den Benutzer zur Berichtsfilterseite einer zugewiesenen Berichtsvorlage. Wenn in der Berichtsvorlage die direkte Weiterleitung eingeschaltet ist, kann der Aufruf auch direkt zur Berichtsanzeige springen, wenn alle Pflichtfilter übergeben wurden.
Beispiel: https://avendooURLeinfügen.de/d/link?longId=-8197532428135267380&type=203&rf_user=1540986396999,1&rf_courseparticipantprocessingstatus=5&rf_time_begin=06.11.2018&rf_time_end=07.11.2018, wobei longId=Berichtstemplate-Id. Parameter, die mit „rf_“ anfangen, sind Filter, die mit übergeben werden.
Aktuell ist der Deeplink für den dynamischen Bericht „Tätigkeiten eines Benutzers“ ausgelegt. Die Filter in diesem Bericht können mit übergeben werden.
Filter: Tätigkeiten eines Benutzers
Die Filter Parameter müssen nicht angegeben werden. Dementsprechend wird die Filterseite gefüllt.
- rf_user=1540986396999,1 > Benutzer-Id
- rf_user=userloginxy > Benutzername (login)
- rf_courseparticipantprocessingstatus=5 > -1=Keine Einschränkung, 2=Nicht abgeschlossen, 5=Abgeschlossen
- rf_time_begin=06.11.2018 > Startzeitpunkt
- rf_time_end=07.11.2018 > Endzeitpunkt
- rf_assignment_state=60,70 > Kursfreigaben-Status
- Avendoo.ASSIGNMENT_STATE_INITIALIZED: 10 (Initiiert)
- Avendoo.ASSIGNMENT_STATE_PLANNED: 20 (In Planung)
- Avendoo.ASSIGNMENT_STATE_FREEZED: 30 (Entscheidung)
- Avendoo.ASSIGNMENT_STATE_DECLINED_LATER: 40 (Abgelehnt später)
- Avendoo.ASSIGNMENT_STATE_DECLINED_NEVER: 50 (Abgelehnt)
- Avendoo.ASSIGNMENT_STATE_APPROVED: 55 (Genehmigt)
- Avendoo.ASSIGNMENT_STATE_ACTIVE: 60 (Aktiv)
- Avendoo.ASSIGNMENT_STATE_CLOSED: 70 (Geschlossen)
- Avendoo.ASSIGNMENT_STATE_ARCHIVED: 80 (Archiviert)
Deeplink und SSO
Wenn ein Deeplink das Attribut „SSO“ beinhaltet, dann überprüft Avendoo®, ob eine Session für den Benutzer im IDP-System besteht. Beispiel: https://avendooURLeinfügen.de/d/link?longId=1432804989438,1&sso=idp&type=41&lang=de
Weiterhin können Sie Deeplinks an SSO für ganze Mandanten anpassen (siehe Feld „Identity Provider Id“ auf dem Reiter „Optionen“ im Mandanten-Assistenten). Die Information für den Internet Provider finden Sie in der Systemeinstellung „saml.configuration“. Wenn kein Präfix in dieser Konfiguration gewählt ist, setzen Sie „idp“ für den Internet Provider im Deeplink ein. Wenn ein Präfix, z.B. „adfs“ gewählt ist, setzen Sie das Präfix für den Internet Provider im Deeplink ein.
Beispiel für einen Deeplink mit Registrierungscode: https://avendooURLeinfügen.de/d/link?longId=1481622803041,1&type=41&sso=idp&Code=REGCODE_NAME
Im Admin-Bereich besteht die Möglichkeit innerhalb der „deeplink.configuration“ folgende Parameter zu setzen:
logoutRedirectUrlSso = URL, auf die der Benutzer weitergeleitet wird, wenn er selbst einen SSO-Link eingegeben hat und den Kurs/Trainingsplan/Lerninhalt verlassen will.
logoutRedirectUrl = URL, auf die der Benutzer weitergeleitet wird, wenn er selbst einen Link eingegeben hat und den Kurs/Trainingsplan/Lerninhalt verlassen will.
redirectFailedUrl = URL, auf die der Benutzer weitergeleitet wird, wenn der Deeplink fehlerhaft ist.
Mehrfache Konfiguration: Für Avendoo® können mehrere IDP’s hinterlegt werden mit einem jeweiligen Kennzeichner als Präfix.
Ja nach Identifier am Benutzer oder am Deeplink werden die entsprechenden Werte genutzt. Sollte es keinen Wert für genauen Wert geben, dann kann immer noch ein Standard-Wert ohne Präfix hinterlegt werden.
Zum Beispiel (bezogen auf nur einen Wert):
…
logoutRedirectUrlSso = www.url1.de
idp2.logoutRedirectUrlSso = www.url2.de
logoutRedirectUrlSso = www.url-standard.de
…
Einstellungen für Registrierungsformular auf Login-Seite: Sollte der Benutzer im Falle eines Deeplinks auf die Login-Seite gelangen und noch kein Benutzer-Konto besitzen, dann kann er sich registrieren. Dazu muss ein entsprechender Registrierungscode angelegt werden. Im Anschluss gelangt der Benutzer per Deeplink zur entsprechenden Kursfreigabe oder Trainingsplan.
loginArea.register.active = Schaltet das Registrierungsformular auf der Login-Seite im Falle eines Deeplinks ohne SSO an.
