Zum Hauptinhalt gehen
Version: 4.9

Die BlueMind-Startseite bearbeiten

Präsentation​

Standardmäßig bietet BlueMind die Möglichkeit, das Logo der Startseite anzupassen.

Um die Standard-Startseite durch eine benutzerdefinierte Seite zu ersetzen, muss eine Erweiterung für den HPS-Dienst geschrieben werden.

info

Diese Methode wird als Beispiel angegeben.

Bei Updates muss die Erweiterung eventuell an die neue Version von BlueMind angepasst werden.

Wenn eine solche Erweiterung in Ihrer Installation vorhanden ist, raten wir dringend, ihr Verhalten auf einer Vorproduktionsplattform mit der Version von BlueMind zu testen, die Sie in Produktion nehmen möchten.

Voraussetzungen​

Eine Testinstallation von BlueMind wurde auf die neueste verfügbare Version aktualisiert.

Prinzip​

Die Modifikation der BlueMind-Startseite erfolgt durch das Schreiben einer HPS-Erweiterung, die die offizielle Startseiten-Vorlage und die Ressourcen außer Kraft setzt, um eine eigene Startseite zu definieren.

Initialisieren der Erweiterung​

Definition des Erweiterungsnamens​

Sie müssen einen Namen für Ihre Erweiterung festlegen. Dieser Name darf aus den Zeichen [a-z] und . (Punkt) bestehen.

info

Im weiteren Verlauf dieser Dokumentation haben wir den Namen my.sample.loginpage gewählt; bitte denken Sie daran, diesen durch den von Ihnen für Ihre Erweiterung gewählten Namen zu ersetzen.

Erstellen der Erweiterungsstruktur​

Melden Sie sich als Benutzer root bei der BlueMind-Testinstallation an und gehen Sie anschließend wie folgt vor:

  1. führen Sie die folgenden Befehle aus:
mkdir /root/my.sample.loginpage
cd /root/my.sample.loginpage
mkdir META-INF templates web-resources

  1. Erstellen Sie die Datei /root/my.sample.loginpage/META-INF/MANIFEST.MF mit folgendem Inhalt:
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: my.sample.loginpage
Bundle-SymbolicName: my.sample.loginpage
Bundle-Version: 1.0.0
Bundle-Vendor: bluemind.net
Fragment-Host: net.bluemind.webmodules.loginapp
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
info

Denken Sie daran, die Zeilen Bundle-Name und Bundle-SymbolicName entsprechend dem von Ihnen für Ihre Erweiterung gewählten Namen anzupassen

Definieren Sie Ihre Startseite​

Die Startseite besteht im Wesentlichen aus 2 Datentypen:

  • der HTML-Code der Seite in Form einer Vorlage
  • die Ressourcen, auf die Ihre Seite verweist (Bilder, CSS usw.)

HTML​

Der HTML-Code der Seite muss in die Datei templates/login.xml eingefügt werden. Diese Modelldatei wird von BlueMind analysiert und die Daten werden dynamisch in die Datei eingefügt.

Diese Vorlage muss im Abschnitt <body> den Code des ursprünglichen Anmeldeformulars enthalten. Um die aktuellste Version dieses Codes zu erhalten, rufen Sie bitte die Seite „login.xml“ in unserem Git-Repository auf und kopieren Sie die folgenden Abschnitte:

  1. der Abschnitt von <#if authErrorMsg??> bis </#if> (einschließlich der Tags)
  2. der Abschnitt des Formulars selbst: von
    „“ bis „“
    (einschließlich der Tags)

Zudem muss dem Tag </body> in der Vorlage Folgendes vorangestellt werden:

${jsRuntime}

Ressourcen​

Die Ressourcen Ihrer Startseite, z.B. wie Bilder, CSS-Sheets... - müssen im Ordner web-resources abgelegt werden.

Sie können im HTML-Code direkt auf Ressourcen aus diesem Verzeichnis verweisen. Um beispielsweise die Ressource web-resources/sample.jpg aus der Vorlage templates/login.xml einzufügen:

<img src="sample.jpg>Beispielbild</img>
Tipp

Wenn Sie eine Ordnerstruktur erstellen, verwenden Sie zur Referenzierung relative Pfadangaben, wobei Sie stets web-resources als Stammverzeichnis betrachten. Beispielsweise für eine CSS-Datei, die sich unter /web-ressources/css/style.css befindet:

\<link rel="stylesheet" href="css/style.css" />

Hinweis: Bitte beachten Sie, dass die Verzeichnisstruktur nicht mit einem „/“ beginnt, da dies auf das Stammverzeichnis der Website verweisen würde.

Die Standardressourcen finden Sie in unserem Git-Repository: https://gitlab.bluemind.net/bluemind-public/bluemind/-/tree/master/ui/webmodules/net.bluemind.webmodules.loginapp/web-resources

Generieren und installieren Sie die Erweiterung​

Melden Sie sich als Benutzer root bei der BlueMind-Testinstallation an und gehen Sie anschließend wie folgt vor:

  1. die Erweiterung generieren:
cd /root/my.sample.loginpage
/usr/lib/jvm/bm-jdk/bin/jar cvfm /root/my.sample.loginpage_1.0.0.jar META-INF/MANIFEST.MF .
  1. die Erweiterung installieren:
cd /usr/share/bm-hps/extensions
mkdir my.sample.loginpage
mv /root/my.sample.loginpage_1.0.0.jar my.sample.loginpage/
  1. den HPS-Dienst neu starten:
/etc/init.d/bm-hps stop
rm -rf /var/lib/bm-hps
/etc/init.d/bm-hps start

Nach der Anmeldung in BlueMind muss anstelle der Standard-BlueMind-Seite Ihre Seite angezeigt werden.

info

Sollte die Seite nicht angezeigt werden, führen Sie eine erzwungene Aktualisierung durch, indem Sie die Shift-Taste gedrückt halten, während Sie die Seite neu laden.

Sie können einen Browser im privaten Browsing-Modus verwenden, um mögliche Cache-Effekte zu vermeiden.

Anmerkungen​

Beispiel​

Der in dieser Dokumentation beschriebene Code des Plugins my.sample.loginpage ist auf dieser Website verfügbar: https://github.com/bluemind-net/loginapp-plugin-sample/tree/master/my.sample.loginpage

Um sie zu testen:

  1. Laden Sie die generierte Erweiterung über diesen Link herunter: https://github.com/bluemind-net/loginapp-plugin-sample/raw/master/build/my.sample.loginpage_1.0.0.jar
  2. Beachten Sie die Schritte 2 und 3 im Abschnitt Erstellen und Installieren der Erweiterung
info

Der Inhalt der generierten Erweiterung kann direkt mit einer Software bearbeitet werden, die das ZIP-Komprimierungsformat unterstützt (z. B. WinZip).

Sie können die Vorlagendatei templates/login.xml ersetzen sowie Ressourcen im Ordner web-resources hinzufügen oder entfernen.