Plugin-management

Centrale spil in het ontwikkelingsproces van XperienCentral betreft het plaatsen van plugins. Plugins bevatten naast een groot aantal standaard-functionaliteiten, ook alle maatwerkfunctionaliteiten die aan een XperienCentral-installatie kunnen worden toegevoegd.

Wat is een plugin?

In XperienCentral zijn het platform en componenten van elkaar gescheiden. Dit zorgt voor een flexibel platform dat ontwikkelaars de mogelijkheid biedt om eenvoudig en snel oplossingen of nieuwe functionaliteiten te bouwen.

Plugins zijn geïntroduceerd in GX WebManager 9, waar ze WebManager Component Bundle’s (WCB) werden genoemd. Daarom worden plugins ook nu nog wel ‘WCB’s’ genoemd; het zijn dus inwisselbare termen.

Een plugin is een bundel van diverse bestanden die samen een bepaalde functionaliteit vertegenwoordigen. Veel voorkomende bestandstypes binnen plugins zijn bijvoorbeeld;

• Jsp(f)-bestanden
• Java-class-bestanden
• statische bestanden, zoals
  • JavaScript
  • CSS
  • afbeeldingen

De meest voorkomende plugin is de Presentatie WCB. Deze zal vrijwel altijd op een installatie aanwezig zijn en bevat de meeste vormgevingsgerelateerde bestanden.

Bundel
Plugins zijn doorgaans gebundeld in een jar-bestand dat meestal gezipt wordt. Er bestaat ook de mogelijkheid dat meerdere plugins in één zip-bestand worden geplaatst om een versnelde uitrol mogelijk te maken.

Het Plugins-scherm

Open het Plugins-scherm door in de redactieomgeving van XperienCentral naar [Configuratie] > [Applicatiegereedschap] > [Plugins] te gaan. Dan verschijnt het volgende popup-venster:

Het Plugins-scherm

Pluginoverzicht
Elke entry in het getoonde overzicht correspondeert met één plugin (of: WCB). De volgende informatie wordt hier getoond:

• ID: uniek ID van de betreffende plugin
• Naam: naam van de betreffende plugin
• Versie: het versienummer van de betreffende plugin
• Status: status van de betreffende plugin. Deze kan twee waarden hebben:
  • active: voor operationele plugins
  • resolved: op het moment dat een plugin nog niet volledig is gestart, kan deze status tijdelijk worden getoond. Indien een plugin wordt gestopt, wordt deze status getoond totdat de plugin handmatig weer wordt gestart.
• Niveau: alle maatwerk-plugins hebben niveau 25, daaronder betreft het platform-WCB’s die niet overruled kunnen worden.

Detailview
Door op een regel in het overzicht te klikken, verschijnt de mogelijkheid om de bewuste plugin te kunnen stoppen of te deïnstalleren. Door op de knop [Meer...] te klikken, verschijnt de nodige detailinformatie die betrekking heeft op de plugin. De meest relevante informatie is hier:

• Built-By: degene die de plugin heeft gebouwd
• Bundle-Version: versienummer van de plugin
• Built-Date: wanneer de plugin is gebouwd

Detailview voor een specifieke plugin

Plugins plaatsen (deployen)

Preconditie
Er is door GX Software, een 3^e partij of de klant zelf, één of meerdere plugins ontwikkeld of aangepast. Deze plugin(s) staat/staan op een bekende locatie op een lokale schijf of netwerklocatie.

Het is zaak om te controleren of de plugins voldoen aan de voorwaarde dat het versienummer hoger dan of minimaal gelijk is aan het versienummer van de plugin die actief is op de omgeving waar deze wordt geplaatst.

Bijvoorbeeld:

Van bovenstaande plugin kan alleen versie 1.0.9 of hoger worden geplaatst. Doorgaans zal bij het bouwen van een nieuwe versie van een plugin minimaal de zogenaamde minor-versie (het laatste cijfer 1.0.9) worden opgehoogd.

Acties
Het daadwerkelijke plaatsen van de plugin geschiedt door op de [Browse]-button te klikken. Vervolgens wordt het gewenste plugin-bestand opgezocht en geselecteerd. Door onderaan het venster op de blauwe knop [Toepassen] te klikken, wordt de plugin vervolgens geüpload, uitgepakt en geïnstalleerd op de server.

In de meeste gevallen zal na een korte wachttijd het scherm verversen en kan worden vastgesteld dat de nieuwe versie van de plugin succesvol is geplaatst. Afhankelijk van de omvang van de plugin kan dit enige tijd duren.

Het kan voorkomen dat er een conflict optreedt tijdens het plaatsen. In dat geval wordt na het plaatsen het venster ververst en automatisch het Foutmeldingen-tabblad getoond:

Mogelijke oorzaken hiervoor kunnen zijn;

• het versienummer van de nieuwe plugin is niet hoger dan of gelijk aan de bestaande versie;
• de plugin mist een bepaalde afhankelijkheid van een of meerdere andere plugin(s);
• de plugin is niet correct samengesteld.

Meerdere plugins tegelijk uitrollen
Het is mogelijk om meerdere plugins tegelijkertijd te plaatsen. De acties hiervoor zijn gelijk aan het hierboven beschreven voorbeeld. In dit geval kan een zip-bestand worden samengesteld met daarin meerdere plugin-bestanden (.zip of .jar).