Les packs permettent d’importer et d’exporter le contenu du référentiel. Vous pouvez utiliser des modules pour installer un nouveau contenu, une nouvelle fonctionnalité, transférer du contenu entre les instances et sauvegarder le contenu du référentiel.
À l’aide du gestionnaire de packs, vous pouvez transférer des packs entre votre instance AEM et votre système de fichiers local à des fins de développement.
Un pack est un fichier zip contenant le contenu du référentiel dans un formulaire de sérialisation de système de fichiers, appelé sérialisation du coffre, fournissant une représentation des fichiers et des dossiers facile à utiliser et à modifier. Le contenu inclus dans le pack est défini à l’aide de filtres.
Un pack contient également les méta-informations du coffre, notamment les définitions des filtres et les informations de configuration de l’importation. Des propriétés de contenu supplémentaires, qui ne sont pas utilisées pour l’extraction du pack, peuvent être incluses dans le pack, telles qu’une description, une image visuelle ou une icône. Ces propriétés de contenu supplémentaires sont destinées au consommateur du pack de contenu et ne sont fournies qu’à titre d’informations.
Les modules représentent la version actuelle du contenu au moment où le module est créé. Ils n’incluent pas les versions précédentes du contenu qu’AEM conserve dans le référentiel.
Le Gestionnaire de packs gère les packs de votre installation AEM. Après avoir attribué les autorisations nécessaires, vous pouvez utiliser le Gestionnaire de packs pour différentes actions, comme la configuration, la création, le téléchargement et l’installation des packs.
Pour créer, modifier, charger et installer des packs, les utilisateurs doivent disposer des autorisations appropriées sur les nœuds suivants :
/etc/packages
L’octroi d’autorisations pour les packs peut entraîner la divulgation d’informations sensibles et la perte de données.
Pour limiter ces risques, il est vivement recommandé d’accorder des autorisations à des groupes spécifiques sur des sous-arborescences dédiées uniquement.
Vous pouvez accéder au gestionnaire de packs de trois façons :
http://<host>:<port>/crx/packmgr/
Le gestionnaire de packs est divisé en quatre zones fonctionnelles principales :
Cliquez sur une option dans le panneau de navigation de gauche pour filtrer immédiatement la liste des packs.
Cliquez sur le nom d’un pack pour développer l’entrée dans la liste des packs et afficher plus de détails sur le pack.
Plusieurs actions peuvent être effectuées sur un pack via les boutons de la barre d’outils disponibles lorsque les détails du pack sont développés.
D’autres actions sont disponibles sous le bouton Plus.
Chaque entrée de la liste des packs comporte un indicateur de statut qui vous permet de connaître d’un coup d’œil le statut du pack. Si vous passez la souris sur le statut, vous verrez apparaître une info-bulle contenant le détail du statut.
Si le pack a été modifié ou n’a jamais été conçu, le statut est présenté comme un lien permettant de prendre des mesures rapides afin de le concevoir à nouveau ou de l’installer.
Un pack est essentiellement un ensemble de filtres et les données du référentiel basées sur ces filtres. Dans l’interface utilisateur du gestionnaire de packs, vous pouvez cliquer sur un pack, puis sur le bouton Modifier pour afficher les détails d’un pack, y compris les paramètres suivants.
Vous pouvez modifier différents paramètres du pack pour définir des informations telles que la description du pack, les dépendances et les informations sur le fournisseur.
La boîte de dialogue Paramètres du pack est accessible via le bouton Modifier lors de la création ou de la modification d’un pack. Une fois les modifications effectuées, cliquez sur Enregistrer.
Champ | Description |
---|---|
Nom | Le nom du pack |
Groupe | Pour organiser des packs, vous pouvez saisir le nom d’un nouveau groupe ou sélectionner un groupe existant. |
Version | Texte à utiliser pour la version |
Description | Brève description du pack permettant le balisage HTML pour le formatage |
Miniature | L’icône qui s’affiche dans la liste des packs |
Une miniature fournit une représentation visuelle pour savoir rapidement ce que contient le module. Elle est ensuite affichée dans la liste de modules et peut vous aider à identifier facilement le module ou la classe de module.
Voici des exemples de conventions utilisées pour les modules officiels :
Correctif officiel
Extension ou installation officielle AEM
Pack de services officiel
Utilisez une icône unique pour votre module. Ne réutilisez pas une icône utilisée par Adobe.
Les filtres identifient les nœuds du référentiel à inclure dans le module. Une définition de filtre spécifie les informations suivantes :
Ajoutez des règles à l’aide du bouton +. Supprimez des règles à l’aide du bouton -.
Les règles sont appliquées selon leur ordre, donc positionnez-les dans l’ordre de votre choix à l’aide des boutons fléchés haut et bas.
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 de manière à inclure le contenu de différents chemins d’accès racine.
Lors de la création de filtres, vous pouvez définir un chemin dʼaccès ou utiliser une expression régulière pour spécifier tous les nœuds à inclure ou exclure.
Type de règle | Description |
---|---|
inclusion | L’inclusion d’un répertoire inclut le répertoire en question et l’ensemble des fichiers et des dossiers de ce répertoire (c’est-à-dire la sous-arborescence entière) mais n’inclut pas d’autres fichiers ou dossiers situés sous le chemin d’accès racine spécifié. |
exclusion | L’exclusion d’un répertoire exclut le répertoire en question et l’ensemble des fichiers et des dossiers de ce répertoire (c’est-à-dire la sous-arborescence entière). |
Les filtres de module sont le plus souvent définis lors de la première création du module. Cependant, ils peuvent également être modifiés ultérieurement. Le module devra alors être recréé pour mettre à jour son contenu en fonction des nouvelles définitions de filtre.
Un module peut contenir plusieurs définitions de filtre de manière à pouvoir combiner facilement des nœuds de différents emplacements en un seul module.
Champ | Description | Exemple/Détails |
---|---|---|
Testé avec | Le nom et la version du produit auquel ce paquet est destiné ou avec lequel il est compatible. | 6.5 |
Problèmes résolus | Champ de texte permettant de répertorier les informations relatives aux bugs corrigés dans ce module, un bug par ligne. | - |
Dépend de | Répertorie les autres modules nécessaires pour que le module actuel s’exécute comme prévu une fois installé. | groupId:name:version |
Remplace | Liste des modules obsolètes que ce module remplace | groupId:name:version |
Champ | Description | Exemple/Détails |
---|---|---|
Nom | Nom du fournisseur du module | WKND Media Group |
URL | Adresse URL du fournisseur | https://wknd.site |
Lien | Lien spécifique au module vers une page de fournisseur | https://wknd.site/package/ |
Requiert | Définit s’il existe des restrictions lors de l’installation du module. | Administrateur - Le module ne doit être installé qu’avec des privilèges Administrateur Redémarrage - AEM doit être redémarré après l’installation du module |
Traitement AC | Indique comment les informations de contrôle d’accès définies dans le module sont traitées lors de son importation | Ignorer - Les listes ACL dans le référentiel sont conservées Remplacer - Les listes ACL dans le référentiel sont remplacées Fusionner - Les deux ensembles de listes ACL sont fusionnés FusionnerConserver - Le contrôle dʼaccès dans le contenu est fusionné avec celui fourni avec le module en ajoutant les entrées de contrôle dʼaccès des entités non présentes dans le contenu Effacer - Les listes ACL sont effacées |
Vous pouvez joindre plusieurs captures dʼécran à votre module pour fournir une représentation visuelle de la façon dont le contenu apparaît.
De nombreuses actions peuvent être entreprises sur un module.
Cliquez sur Créer un module.
Si votre instance comporte de nombreux packs, une structure de dossiers peut être mise en place. Il est alors plus facile de naviguer vers le dossier cible requis avant de créer le nouveau pack.
Dans la boîte de dialogue Nouveau pack, saisissez les champs suivants :
Nom du pack - Sélectionnez un nom explicite pour vous aider (vous et les autres) à identifier facilement le contenu du pack.
Version - Champ de texte permettant d’indiquer une version. Elle est ajoutée au nom du pack pour former le nom du fichier ZIP.
Groupe - Il s’agit du nom du groupe (ou du dossier) cible. Les groupes vous aident à organiser vos packs. Si le dossier n’existe pas encore, il est créé pour le groupe. Si vous ne renseignez pas le nom du groupe, le pack est créé dans la liste des packs principale.
Cliquez sur OK pour créer le pack.
AEM place le nouveau pack en haut de la liste des packs.
Cliquez sur Modifier pour définir le contenu du pack. Une fois que vous avez fini de modifier les paramètres, cliquez sur Enregistrer.
Vous pouvez maintenant créer votre pack.
Il n’est pas obligatoire de concevoir immédiatement le pack après lʼavoir créé. Un pack non conçu ne contient aucun contenu et se compose uniquement des données du filtre et des autres métadonnées.
Un pack est souvent conçu au moment où vous créez le pack, mais vous pouvez y revenir ultérieurement pour concevoir ou reconcevoir le pack. Cela peut s’avérer utile si le contenu du référentiel ou les filtres du pack ont été modifiés.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur Concevoir. Une boîte de dialogue vous demande de confirmer que vous souhaitez concevoir le pack, car tout contenu existant du pack sera remplacé.
Cliquez sur OK. AEM crée le pack et répertorie tout le contenu ajouté au pack dans la liste des activités. Une fois l’opération terminée, AEM affiche un message de confirmation indiquant que le pack a été conçu et (lorsque vous fermez la boîte de dialogue) met à jour les informations de la liste de packs.
Une fois quʼun pack est téléchargé dans AEM, vous pouvez modifier ses paramètres.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur Modifier et mettez à jour les Paramètres du pack, au besoin.
Cliquez sur Enregistrer.
En fonction des modifications que vous avez apportées, vous devrez peut-être concevoir à nouveau le pack pour mettre à jour son contenu.
Une fois qu’un pack a été créé, il peut être réencapsulé. La réencapsulation modifie les informations du pack telles que la miniature, la description, etc. sans toucher à son contenu.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur Modifier et mettez à jour les Paramètres du pack, au besoin.
Cliquez sur Enregistrer.
Cliquez sur Plus -> Réencapsuler. Une boîte de dialogue vous demandera une confirmation.
Comme chaque version d’un pack apparaît dans la liste comme n’importe quel autre pack, le gestionnaire de packs peut trouver d’autres versions d’un pack sélectionné.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur Plus -> Autres versions et une boîte de dialogue s’ouvre avec une liste d’autres versions du même pack avec des informations sur le statut.
Une fois un pack créé, vous pouvez afficher son contenu.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Pour afficher le contenu, cliquez sur Plus -> Contenu, et le gestionnaire de packs répertorie l’intégralité du contenu du pack dans le journal des activités.
Pour exécuter une essai de l’installation, cliquez sur Plus -> Test de l’installation et le Gestionnaire de packs établit un rapport sur les résultats dans le journal d’activité comme si l’installation avait été effectuée.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur le bouton Télécharger ou sur le nom du fichier lié au pack dans la zone des détails du pack.
AEM télécharge le pack sur votre ordinateur.
Le partage de modules était un service public centralisé pour distribuer des modules de contenu. Le partage de modules a été remplacé par la Distribution logicielle et ce bouton ne fonctionne plus.
Sélectionnez le dossier de groupe dans lequel vous souhaitez que le module soit chargé.
Cliquez sur le bouton Charger le module.
Fournissez les informations nécessaires sur le module chargé.
Cliquez sur OK, le module sélectionné est chargé et la liste des modules est mise à jour en conséquence.
Le contenu du module existe désormais sur AEM, mais pour rendre le contenu disponible, veillez à installer le module.
Les modules pouvant modifier le contenu existant, il est souvent utile de valider ces modifications avant de les installer.
Le gestionnaire de modules peut effectuer les validations suivantes :
Contenu vérifié
Cette validation inspecte le module pour tous les fichiers JAR (lots OSGi), extrait leur manifest.xml
(qui contient les dépendances de version sur lesquelles le lot OSGi repose) et vérifie que l’instance AEM exporte lesdites dépendances avec les versions correctes.
Comment c’est rapporté ?
Toutes les dépendances de version qui ne peuvent pas être satisfaites par l’instance AEM est 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, car 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.
Contenu vérifié
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é un recouvrement présent dans /apps/sling/servlet/errorhandler/404.jsp
, un module contenant /libs/sling/servlet/errorhandler/404.jsp
, il modifiera donc le fichier existant dans /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 du fichier de recouvrement dans /apps
doit réviser les modifications apportées au fichier recouvert dans /libs
et incorporer les modifications requises, le cas échéant, dans le recouvrement (/apps
) et redéployer le fichier recouvert.
Le mécanisme de validation ne peut pas vérifier si le contenu recouvert a été correctement incorporé dans le fichier recouvert. Par conséquent, cette validation continuera à signaler des conflits même après que les modifications nécessaires auront été apportées.
Contenu vérifié
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 est-ce rapporté ?
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.
Il est recommandé de sʼassurer que les modules n’affectent pas les listes ACL fournies par AEM, car cela pourrait entraîner un comportement inattendu du produit.
La validation des modules peut être effectuée de deux manières différentes :
La validation doit toujours avoir lieu après le chargement du module, mais avant son installation.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Pour valider le module, cliquez sur Plus -> Valider.
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.
La ou les validations sélectionnées sont ensuite exécutées et les résultats sont affichés dans le Journal d’activité du Gestionnaire de modules.
La requête POST se présente comme suit.
https://<host>:<port>/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls
Le paramètre type
peut être n’importe quelle liste non triée séparée par des virgules qui comprend :
osgiPackageImports
overlays
acls
La valeur par défaut de type
est osgiPackageImports
si elle n’est pas explicitement transmise.
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'
Lors de la validation par le biais dʼune requête POST, la réponse est renvoyée sous la forme d’un objet JSON.
Les packs sont définis par leurs filtres. Vous pouvez demander au Gestionnaire de packs d’appliquer les filtres d’un pack au contenu de votre référentiel existant, afin de montrer le contenu du référentiel qui est couvert par la définition du filtre du pack.
Ouvrez les détails du module dans la liste des modules en cliquant sur son nom.
Cliquez sur Plus -> Couverture.
Les détails de la couverture sont répertoriés dans le journal d’activité.
Le chargement d’un pack ajoute uniquement le contenu du pack au référentiel, mais il n’est pas accessible. Vous devez installer le pack chargé pour utiliser son contenu.
L’installation d’un module peut remplacer ou supprimer le contenu existant. Ne chargez un module que si vous êtes sûr qu’il ne supprime ou ne remplace pas du contenu dont vous avez besoin.
Avant l’installation de votre pack, le Gestionnaire de packs crée automatiquement un pack instantané qui contient le contenu qui sera remplacé. Cet instantané est réinstallé lorsque vous désinstallez le pack.
com.day.cq.workflow.launcher.impl.WorkflowLauncherImpl.
La désactivation de WorkflowLauncher permet de s’assurer que la structure d’importation d’actifs ne manipule pas (involontairement) les actifs lors de l’installation.
Ouvrez les détails du pack que vous souhaitez installer à partir de la liste des packs en cliquant sur le nom du pack.
Cliquez soit sur le bouton Installer dans les détails de l’élément, soit sur le lien Installer dans le statut du pack.
Une boîte de dialogue demande confirmation et permet de spécifier des options supplémentaires.
Cliquez sur Installer.
Le journal des activités détaille la progression de l’installation.
Une fois l’installation terminée et réussie, la liste des packs est mise à jour et le mot Installé apparaît dans le statut du pack.
La réinstallation des packs effectue les mêmes étapes sur un pack déjà installé que celle traitées lors de l’installation initiale du pack.
Vous pouvez complètement renoncer au gestionnaire de packs lors de l’installation de packs. AEM peut détecter les packs placés à un emplacement spécifique du système de fichiers local de l’ordinateur hôte et les charger et installer automatiquement.
Sous le dossier d’installation d’AEM, il y a un dossier crx-quicksart
à côté du fichier jar et du fichier license.properties
. Créez un dossier nommé install
sous crx-quickstart
résultant au chemin d’accès <aem-home>/crx-quickstart/install
.
Dans ce dossier, ajoutez vos packs. Ils sont chargés et installés automatiquement sur votre instance.
Une fois le chargement et l’installation terminés, vous pouvez voir les packs dans Gestionnaire de packs comme si vous aviez utilisé l’interface utilisateur du Gestionnaire de packs pour les installer.
Si l’instance est en cours d’exécution, le chargement et l’installation démarrent immédiatement lorsque vous l’ajoutez au pack dans le dossier install
.
Si l’instance n’est pas en cours d’exécution, les packs placés dans le dossier install
sont installés au démarrage par ordre alphabétique.
La désinstallation d’un pack ramène le contenu du référentiel à l’instantané réalisé automatiquement par le gestionnaire de packs avant l’installation.
Ouvrez les détails du pack que vous souhaitez désinstaller à partir de la liste des packs en cliquant sur le nom du pack.
Pour supprimer le contenu de ce pack du référentiel, cliquez sur Plus -> Désinstaller.
Une boîte de dialogue vous invite à confirmer et énumère toutes les modifications apportées.
Le pack est supprimé et l’instantané est appliqué. La progression du processus s’affiche dans le journal des activités.
La suppression d’un pack supprime uniquement ses détails du gestionnaire de packs. Si ce pack a déjà été installé, le contenu installé n’est pas supprimé.
Ouvrez les détails du pack que vous souhaitez supprimer de la liste des packs en cliquant sur le nom du pack.
Le Gestionnaire de modules vous invite à confirmer que vous souhaitez supprimer le module. Cliquez sur OK pour confirmer la suppression.
Les informations sur le pack sont supprimées et les détails sont signalés dans le journal d’activité.
Répliquez le contenu d’un pack afin de l’installer dans l’instance de publication.
Ouvrez les détails du pack que vous souhaitez répliquer depuis la liste des packs en cliquant sur le nom du pack.
Cliquez sur Plus -> Répliquer.
Le package est répliqué et les détails sont signalés dans le journal d’activité.
Les modules AEM peuvent être utilisés pour créer et partager du contenu dans les environnements AEM.
La Distribution logicielle est un service centralisé conçu pour simplifier la recherche et le téléchargement des modules AEM.
Pour plus d’informations, reportez-vous à la documentation sur la Distribution logicielle.
Le gestionnaire de modules n’est actuellement pas intégré à Distribution logicielle, comme c’était le cas avec l’ancien service de partage de modules. Par conséquent, les boutons de partage et autres liens vers le partage de modules dans le gestionnaire de modules ne fonctionnent plus. La solution consiste à télécharger des modules sur votre disque local.