Gestion des plugins

L'outil Plugins et Workspaces est accessible depuis le menu Application de l'écran d'accueil de l'interface d'administration.

Cet écran affiche la liste des plugins et workspaces qui ont été chargés au démarrage de l'application.

Dans un premier temps, nous allons nous attarder sur quelques notions utiles pour vous permettre par la suite de pouvoir utiliser cet outil en tout simplicité.

Notions de plugins, workspaces et points d'extensions

Plugin

Un plugin est un module d'extension. C'est un composant externe et indépendant du noyau principal d'Ametys servant à apporter de nouvelles fonctionnalités.

Le manuel des Plugins recense la plupart des plugins disponibles pour Ametys, comme par exemple, le plugin Actualité ou le plugin Multimédia.

Les plugins se chargent au démarrage de l'application. N'oubliez pas de redémarrer celle-ci après l'ajout d'un nouveau module.

Workspace

Chaque workspace (traduction littérale : espace de travail) est un espace de votre application indépendant des autres. Il possède, entre autre, une charte graphique et des méthodes d'authentification qui lui sont propres.

A titre d'exemple le CMS, l'interface d'Administration et le Repository sont des workspaces disponibles par défaut dans l'application de démonstration d'Ametys.

Points d'extensions

Une des caractéristiques notable d'Ametys est son extensibilité. Les plugins déclarent des extensions dans leur fichiers de configuration pour se brancher sur des points d'extensions. Grâce à ce mécanisme, un développeur peut modifier le comportement de chaque fonctionnalités qui définissent un point d'extension.

Un point d'extension peut être simple ou multiple :

  • Simple : Seule une implémentation de ce point d'extension peut être active. Il faut donc choisir celle qui sera utilisée.
  • Multiple : Plusieurs implémentations de ce point d'extension peuvent être active au même moment et les fonctionnalités qu'elles apportent se cumulent. Chacune de ces extensions peuvent cependant être activée/désactivée individuellement.

Exemples de points d'extensions
Point d'extension simple : org.ametys.runtime.user.UsersManager (sert à gérer les utilisateurs)
Point d'extension multiple : org.ametys.runtime.plugins.core.right.RightsExtensionPoint (sert à définir les droits)

Dans un plugin, les points d'extensions sont définis au sein de "features" qui sont des groupements d'extensions solidaires face à la désactivation. Lorsqu'une "feature" est désactivée, les implémentations des points d'extensions définis dans cette "feature" ne seront plus actives.

Fonctionnalités de l'outil

Vous pouvez afficher 3 vues en sélectionnant les rubriques correspondantes dans la zone Sommaire :

  • Par plugins : cette vue correspond à l'arborescence physique des plugins sur le disque.
  • Par point d'extension : il s'agit d'une vue logique où les plugins sont regroupés par type.
  • Par workspace : il s'agit de la liste des workspaces.

Le bouton documentation vous permet de voir la documentation des plugins. C'est une action contextuelle, en sélectionnant un nœud donné dans l'arbre d'une vue vous obtiendrez la documentation rattachée.

Vue Par plugins

Cette vue correspond à l'arborescence physique des plugins sur le disque. Vous pouvez naviguer à travers l'arborescence des plugins pour obtenir la liste des "features" et le détails des extensions utilisées ou désactivées.

Dans la colonne de droite, le menu Gestion affiche des actions contextuelles. Vous pouvez ainsi activer/désactiver des "features" ou sélectionner des points d'extensions lorsque l'action est possible.

Attention, l'activation et la désactivation de features peuvent mener au blocage de votre application. Veuillez consulter le Manuel d'intégration, notamment la partie Paramétrage du projet, pour plus d'informations.

 

Vue Par point d'extension

Cette vue recense les points d'extensions classés selon leur type : simple ou multiple.Vous pouvez naviguer à travers l'arborescence pour remonter vers les extensions puis les "features" et enfin les plugins où sont configurés ces points d'extensions.

Il est possible d'activer/désactiver les "features" de votre choix à l'aide du menu contextuel Gestion situé dans la colonne de droite.

Vue Par workspace

Cette vue recense les workspace présent dans votre application Ametys.

Cas d'utilisation

Objectif : Changer la gestion des utilisateurs depuis une source de données SQL en source LDAP.

  1. Sélectionner la vue Plugins par point d'extensions.
  2. Descendre dans l'arborescence selon le chemin suivant : Points d'extension>Points d'extensions simples>org.ametys.runtime.user.UsersManager.

  3. On voit que le point d'extension simple actif est org.ametys.runtime.plugins.core.user.CoreModifiableCredentialsAwareJdbc (par défaut dans la version de démonstration).

  4. Sélectionner le point d'extension simple org.ametys.runtime.plugins.core.CredentialsAwareLdapAndJdbc à l'aide de la souris.

  5. Valider votre choix en cliquant sur le bouton d'action Sélectionner dans la zone de Gestion.

  6. Cliquer sur OK après l'ouverture de la fenêtre contextuelle avertissant que les changements ne seront effectifs qu'une fois la validation globale des modifications effectuées.

  7. Valider les modifications globales (ici seul notre changement est concerné) en cliquant sur le bouton d'action Changements dans la zone de Gestion.
  8. Valider la fenêtre contextuelle nommée Dégagement vous avertissant à propos des possibles conséquence liée au redémarrage de l'application dû aux modifications.
  9. Valider la fenêtre contextuelle nommée Changements récapitulant les divers changements en attente.
  10. Une dernière fenêtre contextuelle vous averti du redémarrage imminent de l'application.
  11. Il est alors nécessaire de renseigner les nouveaux paramètres de configuration introduits par le point d'extension sélectionné (paramètres de configuration de l'annuaire LDAP dans notre cas). L'application vous redirigera automatiquement vers l’écran de configuration de ces paramètres.
Étape 1 à 5 : Sélection du nouveau point d'extension

Étape 6 : Validation fenêtre Changement

Étape 7 : Validation globale des changements

Étape 8 : Validation fenêtre Dégagement

Étape 9 : Validation fenêtre Changements

Etape 10 : Validation fenêtre de redémarrage.

Il est aussi possible de passer par la vue par fichiers et suivre le chemin suivant : et de sélectionner l'extension puis de valider les modifications globales.