Zunächst geben wir Ihnen einen Überblick über die wichtigsten Begriffe, die Sie im Zusammenhang mit Notes-Erweiterungen kennen müssen.
Ein Widget stellt in Notes üblicherweise eine Webseite dar, die im Client angezeigt wird und an die diverse Parameter übergeben werden können. Zwei Beispiele: die Google-Suche und die Fahrplanauskunft der Deutschen Bahn.
Die Übergabe der Parameter erfolgt entweder über HTTP/Get oder HTTP/Post. Bei der Google Suche erfolgt dies über eine speziell geformte URL (HTTP/Get), bei Google Maps über Felder in einem Formular (HTTP/Post).
Das Notes-Framework basiert auf Eclipse beziehungsweise Expeditor. Plug-ins sind - meist in Java geschriebene - Erweiterungen hierfür. Ein Plug-in für Notes kennt nahezu jeder Anwender: Sametime. Weitere Beispiele sind der File-Explorer oder Alloy.
Im Widget-Katalog finden Sie alle Widgets und Plug-ins, auf die Sie Zugriff haben. Wie umfangreich dieser ist, hängt vom Administrator ab. Dieser legt fest, welche Plug-ins und Widgets verwendet werden dürfen. Zu allen Objekten im Katalog gehört im Normalfall eine beschreibende XML-Datei extension.xml. Auf Wunsch erstellen Sie eine solche Datei selbst. Wie dies für ein Plug-in funktioniert, erklären wir Ihnen nachfolgend.
Während bei Widgets meist eine kurze XML-Datei genügt, um alle nötigen Daten wie etwa URL und die zu verarbeitenden Parameter weiterzugeben, ist bei Plug-ins auch der auszuführende Programmcode erforderlich. Dieser wird üblicherweise über eine Eclipse-Updatesite weitergereicht. Keine Sorge, dank Domino-Template ist dies auch für Anfänger machbar.
Eigene Plug-ins bereitstellen
Im Folgenden zeigen wir Ihnen, wie Sie selbst ein Plug-in im Widget-Katalog bereitstellen. Dies funktioniert in drei einfachen Schritten. Zunächst müssen eine Updatesite und der Widget-Katalog erstellt werden. Diese beiden Punkte dienen der Vorbereitung und sind nur einmalig notwendig. Anschließend werden das Plug-in installiert, die extension.xml erzeugt und zuletzt das Plug-in in den Widget-Katalog integriert. Weiter unten zeigen wir Ihnen, wie Sie ein bereits im Widget-Katalog existierendes Plug-in installieren.
Um ein Plug-in bereitzustellen, sind der Widget-Katalog sowie eine Eclipse-Updatesite nötig. In den meisten Fällen ist es völlig ausreichend, zur Erstellung der Updatesite eine vorliegende Domino-Schablone zu nutzen. In der Regel erfolgt der Zugriff auf eine Updatesite über HTTP. Lotus Notes erlaubt auch den Zugriff über das Notes-RPC Protokoll. Es ist also nicht zwingend erforderlich, auf dem Server, der die Updatesite bereitstellt, den HTTP-Task zu starten.
Domino-Updatesite erstellen
Bevor Sie eine Updatesite erstellen, stellen Sie sicher, dass Sie die erforderlichen Rechte besitzen. Um dazu in der Lage zu sein, müssen Sie Datenbanken auf dem Server erstellen dürfen.
Wählen Sie zunächst den Menüpunkt Datei/Anwendung/Neu, und tragen Sie im folgenden Dialog folgende Werte ein:
Server(Datenbank): der Server, auf dem die Updatesite zur Verfügung gestellt werden soll
Titel: Updatesite
Dateiname: updatesite.nsf
Server(Schablone): Wählen sie einen Server aus, auf dem die "Eclipse Update Site (8.5)"-Schablone installiert ist.
Schablone: Wählen sie die "Eclipse Update Site (8.5)"-Schablone aus.
Hinweis: Die Schablone steht nur zur Auswahl, wenn die Option Weitere Schablonen anzeigen aktiviert ist.
Widget-Katalog erstellen
Wie schon bei der Updatesite benötigen Sie zum Erstellen eines Widget-Kataloges auf dem Server die Berechtigung zur Datenbankerstellung.
Wählen Sie den Menüpunkt Datei/Anwendung/Neu und tragen Sie im Dialog folgende Werte ein:
Server(Datenbank): der Server, auf dem die Updatesite zur Verfügung gestellt werden soll
Titel(Beispiel): Widget-Katalog
Dateiname(Beispiel): WidgetCatalog.nsf
Server(Schablone): Wählen sie einen Server aus, auf dem die "Widget Catalog (8.5)"-Schablone installiert ist.
Schablone: Wählen sie die "Widget Catalog (8.5)"-Schablone aus.
Hinweis: Die Schablone steht nur zur Auswahl, wenn die Option "Weitere Schablonen anzeigen aktiviert ist.
Damit ist die Vorbereitung abgeschlossen. Um ein Widget oder Plug-in aus dem Katalog installieren zu können, benötigen Sie lediglich Leserechte. Als Autor sollten Sie zumindest Editoren-Rechte besitzen.
Für das Beispiel verwenden wir das File Explorer Plug-in von OpenNTF. Dieses steht wie die meisten Inhalte von OpenNTF unter der Apache-Lizenz und ist lizenzkostenfrei verfügbar.
Der FileExplorer ist ein Plug-in für die Seitenleiste und bietet alle wichtigen Funktionen des Windows Explorers. So können Dateien/Anhänge direkt aus Notes per Drag&Drop in das Dateisystem abgelegt oder aus diesem in Lotus-Notes-Dokumente eingefügt werden. Die Favoritenverwaltung ist intuitiv zu bedienen; zudem können Sie Dateien/Ordner umbenennen, kopieren oder löschen, ohne den Windows Explorer starten zu müssen. Das Plug-in kann von OpenNTF heruntergeladen werden.
Wählen Sie auf der linken Seite Downloads/Release" und laden die Datei File Explorer 1.5.0.zip herunter.
Alternativ können Sie auch den File Navigator oder ein anderes Eclipse-Plug-in verwenden. Die Vorgehensweise ist im Grunde immer die gleiche.
Kopieren Sie die Datei File Explorer 1.5.0.zip in ein temporäres Verzeichnis und entpacken die Datei.
Sie erhalten folgende Dateistruktur:
.\File Explorer 1.5.0
...\org.openntf.fileexplorer.updatesite
...\features
..\org.openntf.fileexplorer.feature_1.5.0.0.jar
...\plugin
...\org.openntf.fileexplorer_1.5.0.0.jar
...\source
Öffnen sie nun die zuvor erstellte Updatesite.
Klicken Sie auf Import Features und wählen anschließend die Datei org.openntf.fileexplorer.feature_1.5.0.0.jar aus dem vorher erstellten temporären Verzeichnis (…/features) aus.
Hinweis: Die feature.jar-Datei aus dem features-Verzeichnis beinhaltet eine Beschreibung beziehungsweise Hinweise des Plug-ins sowie Konfigurationsinformationen. Dazu gehört auch der Dateiname des ausführbaren Codes; in diesem Beispiel ist dies die Datei ...\plugin\org.openntf.fileexplorer_1.5.0.0.jar.
Die extension.xml erstellen
Für die folgenden Schritte muss das Fenster Eigene Widgets in der Seitenleiste angezeigt werden. Wenn dies nicht der Fall ist, überprüfen Sie die Einstellungen unter Datei/Vorgaben/Widgets.
Wählen Sie im Eigene Widgets Fenster die Option Widgets konfigurieren aus -> .../Features und Plug-ins auf einer Updatesite.
Im folgenden Dialog geben Sie die URL der Updatesite an, beispielsweise: http://ihrserver/updatesite.nsf/site.xml.
Falls Sie das Notes-Protokoll verwenden möchten, weil kein HTTP-Task auf dem Server gestartet ist, könnte die Adresse so aussehen: nrpc://ihrserver/updatesite.nsf/site.xml.
Klicken Sie auf Laden. Es sollte nun das File-Explorer-Plug-in zur Auswahl angezeigt werden. Selektieren Sie dieses.
Klicken Sie nun auf Weiter. Im folgenden Dialog können sie noch eine Beschreibung und/oder eine Grafik-URL angeben.
Klicken Sie auf Fertigstellen und warten Sie, bis der Dialog FileExplorer in IBM Lotus Notes angezeigt wird. Markieren Sie Dieses Plug-in installieren.
Klicken Sie auf OK, warten Sie, bis der Dialog IBM Lotus Notes angezeigt wird, und klicken auf Ja, wenn Sie aufgefordert werden, Lotus Notes neu zu starten.
Die extension.xml exportieren
Nach dem Neustart von Lotus Notes sollte im Fenster Eigene Widgets in der Seitenleiste das File-Explorer-Widget angezeigt werden. Zum Erstellen der extension.xml gehen Sie wie folgt vor: Markieren Sie das File-Explorer-Widget, und wählen Sie aus dem Widget-Menü Exportieren.
Im folgenden Standard-Dateidialog wählen Sie den Ort und den Dateinamen für die Extension-Datei aus.
Die extension.xml in den Widget-Katalog importieren
Öffnen Sie den Widget-Katalog.
Wählen Sie Widget zum Katalog hinzufügen. Es erscheint folgende Maske:
Füllen Sie die Maske nun aus. Dies könnte folgendermaßen aussehen:
Titel: File Explorer
Kategorie: optionale
Hinweis: Die Angabe eine Kategorie ist für eine automatische Installation über Richtlinien zwingend, da in der Richtlinie die Kategorie angegeben wird.
Sollten Sie also planen, Widgets über Richtlinien auszurollen, ist eine sinnvolle Kategorisierung wichtig, beispielsweise Widgets für Marketing, Controlling, alle Mitarbeiter oder optionale.
Plattform: Wenn ein Plug-in eine bestimmte Plattform voraussetzt, sollte diese angegeben werden. Das File-Explorer-Plug-in zum Beispiel läuft ab Notes 8.5.
Plug-in und Funktionen: Zutreffendes markieren
Beschreibung: Hier fügen Sie einen beschreibenden Text zu Ihrem Plug-in ein.
Anhang: Hier muss die erstellte extension.xml-Datei eingefügt werden. Klicken Sie hierzu auf Anhängen und wählen die Datei aus.
Details: Hier können Sie optionale Angaben anfügen.
Wenn Sie nun Speichern und schließen wählen, sollte das neue Dokument in der Ansicht angezeigt werden.
Widgets und Plug-ins aus dem Katalog installieren
Um die Installation eines Widgets aus dem Katalog heraus zu testen, müssen Sie zuerst das gerade erstellte Plug-in deinstallieren. Klicken Sie dazu im Fenster Eigene Widgets mit der rechten Maustaste auf das File-Explorer-Widget. Wählen Sie nun aus dem Kontextmenü Entfernen.
Im Dialog Entfernen bestätigen klicken sie auf Ja. Warten Sie, bis der Dialog IBM Lotus Notes erscheint. Bestätigen Sie nun den Neustart.
Für die Installation eines Widgets aus dem Widget-Katalog gibt es zwei Möglichkeiten: Die erste ist die Installation durch den Administrator. Hierzu müssen entsprechende Richtlinien erstellt werden. Die Einstellungen finden sich in den Desktop Settings unter dem Tab Widgets. Hier können durch den Administrator auch der Standard-Widget-Katalog und alle anderen Widget-Einstellungen, etwa für den Livetext, vorgegeben werden.
Die zweite Möglichkeit ist die Installation durch den Endanwender. Dies geht wie folgt vonstatten: Der Katalog kann über Datei/Öffnen/Lotus Notes-Anwendung geöffnet werden. Damit der Zugriff auf den Katalog einfacher ist, sollte er in den Vorgaben eingetragen werden. Das funktioniert über das Menü Datei/Vorgaben. Dort wählen Sie den Punkt Widgets, klicken auf Durchsuchen und wählen den passenden Server und den zugehörigen Widget-Katalog. Schließen Sie nun den Dialog Benutzervorgaben, indem Sie mit OK bestätigen. Diese Einstellungen können übrigens auch per Richtlinie definiert werden.
Die bisher beschriebenen Schritte müssen nur einmalig durchgeführt werden, dann haben Sie immer schnellen Zugriff auf die Widgets. Wie Sie einzelne Erweiterungen installieren, zeigen wir Ihnen im Folgenden.
Wählen sie im Eigene-Widgets-Fenster die Option Katalog/Durchsuchen.
Es wird eine Widget-Katalog-Anwendung geöffnet.
Wählen Sie dort das Dokument mit dem von Ihnen erstellten Widget aus und öffnen dieses. In diesem Beispiel wäre es File Explorer 1.5.0.
Im Dokument klicken Sie mit der Maus auf den Anhang extension.xml und ziehen ihn auf das Fenster Eigene Widgets. (tlo)