Der Dialog Module gibt eine Übersicht über alle am Portal registrierten Module.

Übersicht

Der Übersichtstabelle können Sie den Namen, die URLs und die Aktivität eines registrierten Moduls entnehmen.

Die Spalte URLs enthält pro Modul die folgenden drei URLs: Basis URL des Moduls, Login URL des Moduls und API URL des Moduls.

Der Spalte aktiv können Sie entnehmen, ob das jeweilige Modul erreichbar ist. Das Status-Symbol kann eine von drei Farben annehmen:

• Grün: Das Modul ist aus Sicht des Moduls erreichbar und eine Kommunikation kann stattfinden
• Orange: Das Modul ist aus Sicht des Moduls erreichbar, jedoch ist die Kommunikation gestört. Um die Kommunikation wieder herzustellen können Sie dieses Modul aus der Übersicht löschen und den Server des Moduls neustarten.
• Rot: Das Modul ist aus Sicht des Moduls nicht erreichbar. Ggf. ist der Server des Moduls heruntergefahren.

Durch Kicken des Papierkorb-Symbol können Sie ein registriertes Modul löschen und damit deregistrieren. Ist ein Modul deregistriert, kann es nicht mehr verwendet werden.

Über das Bleistift- und das Brillen-Symbol erreichen Sie die Detailansicht des Moduls im Bearbeitungs- bzw. Lese-Modus.

Anlegen / Editieren

Im Regelfall ist nicht notwendig ein Modul manuell anzulegen oder zu editieren. Sollte es dennoch nach Absprache mit dem Modulhersteller notwendig sein, ein Modul manuell anzulegen oder zu editieren, tragen Sie die abgesprochenen Parameter wie folgt ein:

• Modulname
  Wählen Sie aus den Einträgen der Dropdown-Liste das passende Modul aus
• Root URL
  Geben Sie die Root URL des Moduls an. (z.B.: http://localhost/modul)
• Login URL
  Geben Sie die Login URL des Moduls an. (z.B.: http://localhost/modul/login)
• Api URL
  Geben Sie die Api URL des Moduls an. (z.B.: http://localhost/modul/api)

Die Felder URL Präfix und Alternative Login URL sind optional. Die Kombination der beiden Parameter ermöglichen es ein Modul über zwei verschiedene Routen anzusprechen.

• URL Präfix
  Mit dem URL Präfix wird ermittelt, ob die Alternative Login URL verwendet werden soll. (z.B.: http://internet-access/)
  Dabei können URL Teile wie die Portangabe durch das Setzen in geschweifte Klammern als optional definiert werden. (z.B.: http://internet-access{:80}/)
• Alternative Root URL 
  Stimmt die aufgerufene URL mit dem URL Präfix überein, wird für verschiedene URLs die Alternative Root URL als Basis verwendet

• Alternative Login URL
  Stimmt die aufgerufene URL mit dem URL Präfix überein, wird für den Modul-Login nicht die reguläre Login URL verwendet, sondern die Alternative Login URL
  

  Beispiel

  
  

  Konfiguration
  Login URL	http://localhost/modul/login
  URL Präfix	http://internet-access{:80}/
  Alternative Root URL	http://internet-access:80/module
  Alternative Login URL	http://internet-access:80/module/login

  Ruft ein Benutzer die Modul-URL http://localhost/modul auf, so wird dieser nach erfolgreicher Anmeldung umgeleitet auf http://localhost/modul/login.

  Ruft ein Benutzer die Modul-URL http://internet-access/modul auf, so wird dieser nach erfolgreicher Anmeldung umgeleitet auf http://internet-access:80/module/login.

Direkt nach erfolgreichem Speichern wird in das Feld Client ID die generierte Client ID und in das Feld Secret das Secret des Moduls geschrieben. Tragen Sie diese beiden Informationen direkt in das passende Modul ein. Der Speicherort ist abhängig vom Modul.