- Thomas Pollinger
- 11.04.2019
- DE
SmartExtensions: Das neue OWUG Plug-In Framework
Wie schon auf dem letzten WSM-Camp in Karlsruhe angekündigt. Gibt es nun über die OpenText Web Solutions Usergroup e.V. (OWUG) ein eigenes Plug-In Framework: SmartExtensions. Dieses neue Framework und auch die Plug-Ins daraus, gibt es als gratis Download via Github. Über die Zeit werden wir die bestehenen, freien und neue Plug-Ins in das neue Framework überführen.
Warum machen wir das?
Die Idee hinter diesem Framework ist, dass alle Nutzer des Web Site Management (RedDot CMS) optimierte Erweiterungen für den Management Server gratis bekommen. Denn es gibt viele Ansätze für Erweiterungen, die einen in Java, die anderen in PHP oder ASP usw. Jedoch für einen System-Admin wird es zunehmend schwerer, je mehr unterschiedliche Technologien man pflegen muss.
Aus diesem Grund möchten wir als OWUG die Möglichkeit bieten, dass wir alle gemeinsam an einem Plug-In Set arbeiten. Und somit über die Zeit ein gewaltiges Set an passend zugeschnitten Erweiterungen bekommen. Welche über die Community gepflegt, erweitert und getestet wird.
Welche Technologien kommen hier zum Einsatz?
Wir möchten auf derzeit marktübliche Webtechnologien setzen, daher haben wir uns entschieden die Erweiterungen (Plug-Ins) aus Basis von:
- HTML 5
- CSS 3
- JavaScript ES6
- Kommunikation via AJAX an RQL-Proxy
Dazu verwenden wir ebenfalls weitere marktübliche Pakete wie:
- Bootstrap
- jQuery
- Handlebars.js
- Font Awesome
- Normalize
- u.v.m.
welche jeweils in der aktuellsten Version vorgehalten werden.
Welche Lizenz kommt zum Einsatz?
Wir werden alles unter der MIT-Lizenz auf Github bereitstellen. Denn auch die genutzen 3rd Party Pakete sind alle unter der MIT-Lizenz erhältlich. Daher ist es nur fair und sinnvoll dies auch selbst im gleichen Lizenzmodell zu verbreiten.
Was benötige ich um die Erweiterungen selbst produktiv zu nutzen?
Aktuell haben wir uns primär auf das Release 16.x oder neuer des Web Site Management Servers konzentriert. Jedoch werden, bis auf ganz wenige, die Erweiterungen (Plug-Ins) auch im letzten Release von 11.2.2 lauffähig sein. Nur wenn die nötigen Features unter RQL oder REST nicht verfügbar sind, abhängig je Release, werden einige Plug-Ins nicht funktionsfähig sein. Doch damit alles auch korrekt funktioniert, gibt es im Paket einen Installer welcher dafür sorgt, dass nur die lauffähigen Versionen je Management Server Version angeboten werden.
Die Installation und Inbetriebnahme läuft wie bei anderen Plug-Ins, jedoch muss man selbst nur den s.g. Paket-Manager importieren. Den Rest übernimmt dann dieses zentrale Plug-In innerhalb des Server-Managers.
Was benötige ich um selbst eigene Erweiterungen zu entwicklen?
Um selbst an dem o.g. Projekt mitzuentwicklen, benötigt man nur die Fähigkeiten mit den zuvor genannten Frameworks umzugehen. Dazu noch eine Idee was machen machen möchte und wir empfehlen folgende Tools:
- Visual Studio Code als IDE
- PowerShell 5.1 oder neuer für den Build-Process
- Spaß am entwicklen von Erweiterungen für den Managment-Server
Wie kann ich mitmachen?
Um an der zentrale Entwicklung der Community mitmachen zu können, sind drei einfache Schritte notwendig:
- Anmeldung in unserer kostenlosen Slack-Community
- Kurze Meldung im Channel #owug-externsions
- Ein Github-Konto für den Zugriff auf das Repository
Was muss ich noch wissen?
Über die kommenden Wochen wird es regelmäßig Artikel zu unserem neuen Framework geben. In diesen Artikeln wird Schritt für Schritt der Einstieg, die Struktur, das Tooling und die Einstellungen der IDE erläutert.
Dannach werden die bereits bestehenden Strukturen, Möglichkeiten und sonstigen relevanten Dinge erklärt, damit man schnell und einfach einsteigen kann.
Wo finde ich was?
Das Framework selbst wird in den kommenden Tagen auf Github verfügbar sein. Die Artikel werden nach der Reihe im Know-How Bereich verfügbar sein.
Für sonstige Fragen einfach über unsere Slack-Community oder per E-Mail in Kontakt treten.
Viel Spaß und bis bald...
Geplante Artikel:
- SmartExtensions: Einstieg
- SmartExtensions: Projektaufbau und Struktur
- SmartExtensions: RQL-Connector inkl. Session- und Objektaufbau
- SmartExtensions: Funktionsaufbau und Arbeitsweise
- SmartExtensions: Browser-Console und Debugging
- SmartExtensions: Mehrsprachenfähigkeit
- SmartExtensions: Build-Process und Build-Pakete
- SmartExtensions: SmartEdit-Feature
- SmartExtensions: SmartTree und Server Manager Features
- SmartExtensions: Framework und Asset-Folder Features
Über den Autor:
... ist Senior Site Reliability Engineer bei der Vodafone GmbH in Düsseldorf. Seit dem Jahr 2007 betreut er zusammen mit seinen Kollegen die OpenText- (vormals RedDot-) Plattform Web Site Management für die deutsche Konzernzentrale.
Er entwickelt Erweiterungen in Form von Plug-Ins und PowerShell Skripten. Seit den Anfängen in 2001 (RedDot CMS 4.0) kennt er sich speziell mit der Arbeitweise und den Funktionen des Management Server aus.