Utilisation des modules

Les modules permettent d’importer et d’exporter le contenu du référentiel. Par exemple, vous pouvez utiliser des modules pour installer une nouvelle fonctionnalité, transférer du contenu entre des instances et sauvegarder le contenu d’un référentiel.

Les modules sont accessibles et/ou conservés à partir des pages suivantes :

• Gestionnaire de modules, que vous utilisez pour gérer les modules dans l’instance locale d’AEM.

• Distribution logicielle, un serveur centralisé contenant à la fois des packages disponibles publiquement et des packages privés pour votre entreprise. Les modules publics peuvent contenir des correctifs, des nouvelles fonctionnalités, des documents, etc.

Vous pouvez transférer des modules entre Package Manager, Distribution logicielle et votre système de fichiers.

Que sont les modules ?

Un module est un fichier ZIP contenant le contenu d’un référentiel sous forme de sérialisation de système de fichiers (appelé sérialisation « coffre-fort »). Il offre une représentation facile à utiliser et à modifier des fichiers et des dossiers.

Les modules comportent du contenu, du contenu du page et du contenu lié au projet, sélectionnés à l’aide de filtres.

Un module contient également les méta-informations du coffre-fort, dont les définitions des filtres et les informations de configuration de l’importation. D’autres propriétés de contenu (qui ne sont pas utilisées pour l’extraction de package) peuvent être incluses dans le package, telles qu’une description, une image visuelle ou une icône ; ces propriétés sont destinées au consommateur du module de contenu et à titre d’information uniquement.

Vous pouvez effectuer les actions ci-dessous sur des modules ou avec des modules :

• Créer des modules, en définissant leurs paramètres et les filtres, au besoin
• Prévisualiser le contenu des modules (avant la création)
• Créer des modules
• Afficher les informations des modules
• Afficher le contenu des modules (après la création)
• Modifier la définition des modules existants
• Recréer des modules existants
• Réencapsuler des modules
• Télécharger des modules d’AEM vers le système de fichiers
• Charger des modules de votre système de fichiers dans votre instance d’AEM locale
• Valider le contenu du module avant l’installation
• Exécution d’une installation d’exécution d’essai
• Installer des modules (AEM n’installe pas automatiquement les modules après le chargement)
• Supprimer des modules
• Télécharger des modules, tels que des correctifs, depuis la bibliothèque Distribution logicielle
• Chargement de modules dans la section interne à l’entreprise de la bibliothèque de distribution de logiciels

Informations sur les modules

Une définition de module comprend différents types d’informations :

• Paramètres du module
• Filtres de module
• Captures d’écran de module
• Icônes de module

Paramètres du module

Vous pouvez modifier différents paramètres du module pour définir certains aspects comme la description des modules, les bogues associés, les dépendances et les informations sur le fournisseur.

La boîte de dialogue Paramètres du module est accessible à l’aide du bouton Modifier lors de la création ou de la modification d’un module. Elle contient trois onglets pour la configuration. Après avoir apporté des modifications, cliquez sur OK pour les enregistrer.

Filtres de module

Les filtres identifient les nœuds du référentiel à inclure dans le module. Une Définition de filtre spécifie les informations suivantes :

• Chemin d’accès racine du contenu à inclure.
• ​​Règles qui incluent ou excluent des noeuds spécifiques sous le chemin racine.

Les filtres peuvent ne comporter aucune règle ou en comporter plusieurs. Lorsqu’aucune règle n’est définie, le module contient tout le contenu sous le chemin d’accès racine.

Vous pouvez définir une ou plusieurs définitions de filtre pour un module. Utilisez plusieurs filtres pour inclure le contenu de plusieurs chemins racine.

Le tableau ci-dessous décrit ces règles et fournit des exemples :

Les filtres de module sont le plus souvent définis lorsque vous créez le module, mais ils peuvent également être modifiés par la suite (après quoi le module doit être recréé).

Captures d’écran de module

Vous pouvez associer des captures d’écran au module afin de fournir une représentation visuelle du contenu, par exemple, en fournissant des captures d’écran de la nouvelle fonctionnalité.

Icônes de module

Vous pouvez également associer une icône au module afin de fournir une représentation visuelle de référence rapide du contenu du module. Elle est ensuite affichée dans la liste de modules et peut vous aider à identifier facilement le module ou la classe du module.

Dans la mesure où un module peut contenir une icône, les modules officiels suivent les conventions ci-dessous :

Module de correctif officiel :

Module d’installation ou d’extension d’AEM officiel :

Feature Packs officiels :

Gestionnaire de modules

Le Gestionnaire de modules gère les modules dans l’installation locale d’AEM. Après avoir affecté les autorisations nécessaires, vous pouvez utiliser le Gestionnaire de modules pour différentes actions, dont la configuration, la création, le téléchargement et l’installation des modules. Les principaux éléments à configurer sont les suivants :

• Paramètres du module
• Filtres de module

Autorisations nécessaires à l’utilisation du Gestionnaire de modules

Pour accorder aux utilisateurs le droit de créer, de modifier, de charger et d’installer des modules, vous devez leur affecter les autorisations appropriées aux emplacements suivants :

• /etc/packages (tous les droits à l’exception des droits de suppression)
• nœud contenant le contenu du module

Pour plus d’informations sur la modification des autorisations, voir Définition des autorisations.

Création d’un module

Pour créer une définition de module :

1. Dans l’écran d’accueil d’AEM, cliquez sur Packages (ou dans la console Outils, double-cliquez sur Packages).

2. Ensuite, sélectionnez Gestionnaire de modules.

3. Cliquez sur Créer un package.

   REMARQUE

   Si l’instance comporte de nombreux modules, il peut y avoir une arborescence en place afin de pouvoir accéder au dossier cible nécessaire avant de créer le module.

4. Dans la boîte de dialogue :

   

   Renseignez les champs :

   • Nom du groupe

     Nom du groupe cible (ou dossier). Les groupes vous aident à organiser vos modules.

     Si le dossier n’existe pas encore, il est créé pour le groupe. Si vous ne renseignez pas le nom du groupe, le module est créé dans la liste de modules principale (Accueil > Modules).

   • Nom du module

     Le nom de votre nouveau package. Sélectionnez un nom explicite pour vous aider (entre autres) à identifier facilement le contenu du module.

   • Version

     Champ de texte permettant d’indiquer une version. Il sera ajouté au nom du module pour former le nom du fichier ZIP.
     Cliquez sur OK pour créer le module.

5. AEM répertorie le nouveau module dans le dossier de groupe approprié.

   

   Cliquez sur l’icône ou le nom du module à ouvrir.

   

   REMARQUE

   Vous pouvez revenir sur cette page ultérieurement, si nécessaire.

6. Cliquez sur Modifier pour modifier les paramètres du module .

   Ici, vous pouvez ajouter des informations et/ou définir certains paramètres, par exemple, une description, l’icône, les bogues associés et ajouter des informations sur le fournisseur.

   Une fois que vous avez fini de modifier les paramètres, cliquez sur OK.

7. Ajoutez des captures d’écran au module, au besoin. Une seule instance est disponible lorsque le module est créé. Ajoutez-en davantage, si nécessaire, à l’aide de Captures d’écran de module à partir du Sidekick.

   Ajoutez l’image réelle en double-cliquant sur le composant Image dans la zone Captures d’écran, en ajoutant une image et en cliquant sur OK.

8. Définissez les filtres de module en faisant glisser des instances de la définition de filtre à partir du Sidekick, puis en double-cliquant pour l’ouvrir pour le modifier :

   

   Précisez les paramètres suivants :

   • Chemin d’accès racine Contenu à grouper. Il peut s’agir de la racine d’une sous-arborescence.

   • Règles Les règles sont facultatives. Pour des définitions de module simples, il n’est pas nécessaire de spécifier de règles d’inclusion ou d’exclusion.

     Si nécessaire, vous pouvez définir des règles d’inclusion ou d’exclusion afin de définir précisément le contenu d’un module.

     Ajoutez des règles à l’aide du symbole +. Vous pouvez également supprimer des règles à l’aide du symbole -. Les règles sont appliquées selon leur ordre, donc positionnez-les dans l’ordre de votre choix à l’aide des touches haut et bas.
     Ensuite, cliquez sur OK pour enregistrer le filtre.

   REMARQUE

   Vous pouvez utiliser autant de définitions de filtre que nécessaire, mais vous devez veiller à ce qu’elles n’entrent pas en conflit. Utilisez Aperçu pour confirmer le contenu du module.

9. Pour confirmer le contenu du module, vous pouvez utiliser Aperçu. Une exécution d’essai du processus de création est effectuée, et tout ce qui sera ajouté au module lors de sa création effective est répertorié.

10. Vous pouvez maintenant créer votre module.

    REMARQUE

    Vous n’êtes pas tenu de créer le module à ce stade. Vous pouvez le faire ultérieurement.

Création d’un module

Un module est souvent créé au moment où vous créez la définition du module, mais vous pouvez y revenir ultérieurement pour créer ou recréer le module. Cela peut s’avérer utile si le contenu du référentiel a changé.

1. Ouvrez la définition de module à partir du Gestionnaire de modules (cliquez sur l’icône de module ou le nom du module).

2. Cliquez sur Créer. Une boîte de dialogue vous demande de confirmer que vous souhaitez créer le module.

   REMARQUE

   Cela a une importance particulière lorsque vous recréez un module, car le contenu du module est remplacé.

3. Cliquez sur OK. AEM crée le module, en répertoriant tout le contenu ajouté au module. Une fois l’opération terminée, AEM affiche un message de confirmation indiquant que le module a été créé et (lorsque vous fermez la boîte de dialogue) met à jour les informations de la liste de modules.

Réencapsulation d’un module

Une fois qu’un module a été créé, il peut être réencapsulé, si nécessaire.

La réencapsulation modifie les informations du module, sans modifier le contenu du module. Les informations du module sont la vignette, la description, etc., en d’autres termes tous les paramètres que vous pouvez modifier dans la boîte de dialogue Paramètres du module (pour l’ouvrir, cliquez sur Modifier).

Un cas d’utilisation majeur pour le réencapsulage est lors de la préparation d’un module. Par exemple, vous pouvez avoir un module existant et décider de le partager avec d’autres personnes. À cet effet, vous souhaitez ajouter une vignette et une description. Au lieu de recréer le module entier avec toutes ses fonctionnalités (ce qui peut prendre un certain temps et vous expose au risque que le module ne soit plus identique à l’original), vous pouvez le réencapsuler et ajouter simplement la vignette et la description.

1. Ouvrez la définition de module à partir du Gestionnaire de modules (cliquez sur l’icône de module ou le nom du module).

2. Cliquez sur Modifier et mettez à jour Paramètres du module, au besoin. Cliquez sur OK pour enregistrer.

3. Cliquez sur Réencapsuler. Une boîte de dialogue de confirmation s’affiche.

Affichage et modification des informations de module

Pour afficher ou modifier des informations sur une définition de module :

1. Dans le Gestionnaire de modules, accédez au module à afficher.

2. Cliquez sur l’icône de module du module à afficher. Cette action affiche la page du module qui répertorie les informations sur la définition du module:

   

   REMARQUE

   À partir de cette page, vous pouvez également modifier et effectuer certaines opérations sur le module.

   Les boutons disponibles varient selon que le module a été créé ou non.

3. Si le module a déjà été créé, cliquez sur Contenu. Une fenêtre qui répertorie tout le contenu du module s’affiche :

Affichage du contenu du module et test de l’installation

Une fois un module créé, vous pouvez afficher son contenu :

1. Dans le Gestionnaire de modules, accédez au module à afficher.

2. Cliquez sur l’icône de module du module à afficher. Cette action affiche la page du module qui répertorie les informations sur la définition du module.

3. Pour afficher le contenu, cliquez sur Contenu. Une fenêtre qui répertorie tout le contenu du module s’affiche :

   

4. Pour effectuer une exécution d’essai de l’installation, cliquez sur Tester l’installation. Une fois que vous avez confirmé l’action, une fenêtre qui répertorie les résultats comme si la configuration avait été effectuée s’affiche :

   

Téléchargement des modules sur votre système de fichiers

Cette section décrit comment télécharger un module d’AEM vers votre système de fichiers à l’aide du Gestionnaire de modules.

1. Dans l’écran de bienvenue d’AEM, cliquez sur Packages, puis sélectionnez Gestionnaire de modules.

2. Accédez au module à télécharger.

   

3. Cliquez sur le lien formé par le nom du fichier ZIP (souligné) pour le module à télécharger, par exemple, export-for-offline.zip.

   AEM télécharge le module sur votre ordinateur (à l’aide d’une boîte de dialogue de téléchargement de navigateur standard).

Chargement des modules à partir du système de fichiers

Un chargement de package vous permet de charger un package de votre système de fichiers dans AEM Package Manager.
Pour charger un module :

1. Accédez au Gestionnaire de modules. Accédez ensuite au dossier du groupe dans lequel vous souhaitez charger le module.

   

2. Cliquez sur Upload Package (Télécharger le package).

   

   • File

     Vous pouvez saisir directement le nom du fichier ou utiliser la commande Parcourir… pour sélectionner le module requis dans votre système de fichiers local (après la sélection, cliquez sur OK).

   • Forcer le chargement

     Si un package portant ce nom existe déjà, vous pouvez cliquer dessus pour forcer le téléchargement (et remplacer le package existant).
     Cliquez sur OK afin que le nouveau module soit chargé et répertorié dans la liste Gestionnaire de modules.

   REMARQUE

   Pour mettre le contenu à disposition dans AEM, veillez à installer le module.

Validation de modules

Avant d’installer un module, vous pouvez vérifier son contenu. Comme les packages peuvent modifier des fichiers superposés sous /apps et/ou ajouter, modifier et supprimer des listes de contrôle d’accès, il est souvent utile de valider ces modifications avant l’installation.

Options de validation

Le mécanisme de validation permet de vérifier les caractéristiques suivantes du module :

• Importations de modules OSGi
• Recouvrements
• Listes ACL

Ces options sont détaillées ci-dessous.

• Valider les importations de modules OSGi

  Éléments vérifiés

  Cette option de validation inspecte le module afin de vérifier tous les fichiers JAR (lots OSGi), extrait leur fichier manifest.xml (qui contient les dépendances de version sur lesquelles repose le lot OSGi) et vérifie que l’instance AEM exporte les dépendances avec les versions correctes.

  Comment sont-ils signalés ?

  Toutes les dépendances versionnées qui ne peuvent pas être satisfaites par l’instance AEM sont répertoriées dans le Journal d’activité du gestionnaire de modules.

  États d’erreur

  Si les dépendances ne sont pas satisfaites, les lots OSGi du module avec ces dépendances ne démarrent pas. Cela entraîne un déploiement d’application interrompu, puisque tout ce qui repose sur le lot OSGi non démarré ne fonctionnera pas correctement.

  Résolution d’erreurs

  Pour résoudre des erreurs dues à des lots OSGi non satisfaits, il faut ajuster la version dépendante du lot avec des importations non satisfaites.

• Valider les recouvrements

  Éléments vérifiés

  Cette validation détermine si le module en cours d’installation contient un fichier déjà recouvert dans l’instance AEM de destination.

  Par exemple, étant donné qu’une superposition existante se trouve à /apps/sling/servlet/errorhandler/404.jsp, un module contenant /libs/sling/servlet/errorhandler/404.jsp, de sorte qu’il modifie le fichier existant à /libs/sling/servlet/errorhandler/404.jsp.

  Comment sont-ils signalés ?

  Ces recouvrements sont décrits dans le Journal d’activités du Gestionnaire de modules.

  États d’erreur

  Un état d’erreur signifie que le module tente de déployer un fichier déjà recouvert. Les modifications du module seront donc remplacées (et donc masquées) par le recouvrement et ne prendront pas effet.

  Résolution d’erreurs

  Pour résoudre ce problème, le responsable de l’ du fichier de recouvrement dans /apps doit examiner les modifications apportées au fichier recouvert dans /libs et incorporer les modifications nécessaires dans le recouvrement ( /apps), puis redéployer le fichier recouvert.

  REMARQUE

  Notez que le mécanisme de validation ne permet pas de réconcilier si le contenu superposé a été correctement incorporé dans le fichier de recouvrement. Par conséquent, cette validation continuera à signaler des conflits même après que les modifications nécessaires auront été apportées.

• Valider les listes ACL

  Éléments vérifiés

  Cette validation vérifie quelles autorisations sont ajoutées, comment elles seront gérées (fusion/remplacement) et si les autorisations actuelles seront affectées.

  Comment sont-ils signalés ?

  Les autorisations sont décrites dans le Journal d’activités du Gestionnaire de modules.

  États d’erreur

  Aucune erreur explicite ne peut être fournie. La validation indique simplement si de nouvelles autorisations des listes ACL seront ajoutées ou affectées par l’installation du module.

  Résolution d’erreurs

  Grâce aux informations fournies par la validation, les nœuds affectés peuvent être révisés dans CRXDE et les listes ACL peuvent être ajustées dans le module si besoin.

  ATTENTION

  Il est recommandé que les modules n’affectent pas les listes ACL fournies par AEM, car cela pourrait entraîner un comportement inattendu du produit.

Validation

La validation des modules peut être effectuée de deux manières différentes :

• via l’interface utilisateur du Gestionnaire de modules ;
• via une requête HTTP POST, telle que cURL.

Validation de modules via le Gestionnaire de modules

1. Ouvrez le gestionnaire de modules à l’adresse https://<server>:<port>/crx/packmgr

2. Sélectionnez le package dans la liste, puis sélectionnez la liste déroulante Plus dans l’en-tête, puis Valider dans le menu déroulant.

   REMARQUE

   Cette opération doit être effectuée après le chargement du module de contenu, mais avant son installation.

3. Dans la boîte de dialogue modale qui s’affiche alors, utilisez les cases à cocher pour sélectionner le ou les types de validation et commencez la validation en cliquant sur Valider. Vous pouvez également cliquer sur Annuler.

4. La ou les validations sélectionnées sont ensuite réalisées. Les résultats sont affichés dans le Journal d’activités du Gestionnaire de modules.

Validation de modules via une requête HTTP POST

La requête POST se présente comme suit.

https://<host>:<port>/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls

Voici un exemple illustrant comment exécuter la validation d’un module à l’aide de cURL.

1. Si vous utilisez cURL, exécutez une instruction semblable à celle-ci :

   curl -v -X POST --user admin:admin -F file=@/Users/SomeGuy/Desktop/core.wcm.components.all-1.1.0.zip 'http://localhost:4502/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls'
   

2. La validation demandée est exécutée et la réponse est renvoyée sous forme d’objet JSON.

Installation des modules

Après avoir chargé un module, vous devez installer le contenu. Pour que le contenu du module soit installé et opérationnel, il doit être :

• chargé dans AEM (soit chargé à partir de votre système de fichiers soit téléchargé à partir de Distribution logicielle).

• installé.

1. Dans le Gestionnaire de modules, accédez au module à installer.

   Un bouton Installer s’affiche à côté des modules qui n’ont pas encore été installés.

   REMARQUE

   Vous pouvez également ouvrir le module en cliquant sur l’icône associée pour accéder au bouton Installer.

2. Pour commencer l’installation, cliquez sur Installer. Une boîte de dialogue vous invite à confirmer et répertorie toutes les modifications apportées. Lorsque vous avez terminé, cliquez sur Fermer dans la boîte de dialogue.

   Le mot Installé s’affiche en regard du module une fois qu’il a été installé.

Chargement et installation basés sur le système de fichiers

Il existe une autre façon de charger et d’installer des modules sur votre instance. Dans votre système de fichiers, un dossier crx-quicksart avec votre fichier JAR et le fichier license.properties. Vous devez créer un dossier nommé install sous crx-quickstart. Vous aurez alors quelque chose comme ceci : <aem_home>/crx-quickstart/install

Dans ce dossier d’installation, vous pouvez ajouter directement des modules. Ils sont chargés et installés automatiquement sur votre instance. Une fois l’opération terminée, vous pouvez afficher les modules dans le Gestionnaire de modules.

Si votre instance est en cours d’exécution, l’ajout d’un module au dossier install lance directement le chargement et l’installation sur l’instance. Si votre instance n’est pas en cours d’exécution, les modules que vous placez dans le dossier install sont installés au démarrage dans l’ordre alphabétique.

Désinstallation des modules

AEM vous permet de désinstaller des packages. Cette action renvoie le contenu concerné du référentiel vers l’instantané enregistré juste avant l’installation des modules.

1. Dans le Gestionnaire de modules, accédez au module à désinstaller.
2. Cliquez sur l’icône de module du module à désinstaller.
3. Pour supprimer le contenu de ce module du référentiel, cliquez sur Désinstaller. Une boîte de dialogue vous invite à confirmer et répertorie toutes les modifications apportées. Lorsque vous avez terminé, cliquez sur Fermer dans la boîte de dialogue.

Suppression des modules

Pour supprimer un module dans les listes du Gestionnaire de modules :

1. Dans la console Outils, développez le dossier Packages pour afficher votre package dans le volet de droite.

2. Cliquez sur le module à supprimer afin de le sélectionner, puis :

   • Cliquez sur Supprimer dans le menu de la barre d’outils.
   • Cliquez avec le bouton droit de la souris et sélectionnez Supprimer.

   

3. AEM demande de confirmation que vous souhaitez supprimer le module. Cliquez sur OK pour confirmer la suppression.

Réplication des modules

Répliquez le contenu d’un module afin de l’installer dans l’instance de publication :

1. Dans le Gestionnaire de modules, accédez au module à répliquer.

2. Cliquez sur l’icône de module ou le nom du module à répliquer pour le développer.

3. Dans le menu déroulant Plus de la barre d’outils, sélectionnez Répliquer.

Partage de modules

Le partage de modules était un serveur centralisé, rendu public, permettant de partager des modules de contenu.

Il a été remplacé par Distribution logicielle.

Distribution logicielle

La distribution logicielle est la nouvelle interface utilisateur conçue pour simplifier la recherche et le téléchargement des packages AEM.

Pour plus d’informations, consultez la documentation Distribution logicielle.