Gestionnaire de packages working-with-packages

Les packages permettent d’importer et d’exporter le contenu du référentiel. Vous pouvez utiliser des packages 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 packages, vous pouvez transférer des packages entre votre instance AEM et votre système de fichiers local à des fins de développement.

Que sont les packages ? what-are-packages

Un package 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 package est défini à l’aide de filtres.

Un package 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 package, peuvent être incluses dans le package, 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 package de contenu et ne sont fournies qu’à titre d’informations.

Gestionnaire de packages package-manager

Le Gestionnaire de packages gère les packages de votre installation AEM. Après avoir attribué les autorisations nécessaires, vous pouvez utiliser le Gestionnaire de packages pour différentes actions, comme la configuration, la création, le téléchargement et l’installation des packages.

Autorisations requises required-permissions

Pour créer, modifier, charger et installer des packages, les utilisateurs doivent disposer des autorisations appropriées sur les nœuds suivants :

Accéder au gestionnaire de packages accessing

Vous pouvez accéder au gestionnaire de packages de trois façons :

Interface utilisateur du gestionnaire de packages ui

Le gestionnaire de packages 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 packages.

Cliquez sur le nom d’un package pour développer l’entrée dans la liste des packages et afficher plus de détails sur le package.

Plusieurs actions peuvent être effectuées sur un package via les boutons de la barre d’outils disponibles lorsque les détails du package sont développés.

D’autres actions sont disponibles sous le bouton Plus.

Statut du package package-status

Chaque entrée de la liste des packages comporte un indicateur de statut qui vous permet de connaître d’un coup d’œil le statut du package. Si vous passez la souris sur le statut, vous verrez apparaître une info-bulle contenant le détail du statut.

Si le package 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.

Paramètres du package package-settings

Un package 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 modules, vous pouvez cliquer sur un package, puis sur le bouton Modifier pour afficher les détails d’un package, y compris les paramètres suivants.

Paramètres généraux general-settings

Vous pouvez modifier différents paramètres du package pour définir des informations telles que la description du package, les dépendances et les informations sur le fournisseur.

La boîte de dialogue Paramètres du package est accessible via le bouton Modifier lors de la création ou de la modification d’un package. Une fois les modifications effectuées, cliquez sur Enregistrer.

Miniatures des packages thumbnails

Une miniature fournit une représentation visuelle pour savoir rapidement ce que contient le package. Elle est ensuite affichée dans la liste de packages et peut vous aider à identifier facilement le package ou la classe de package.

Voici des exemples de conventions utilisées pour les packages officiels :

Correctif officiel

Extension ou installation officielle AEM

Pack de services officiel

Utilisez une icône unique pour votre package. Ne réutilisez pas une icône utilisée par Adobe.

Filtres de package package-filters

Les filtres identifient les nœuds du référentiel à inclure dans le package. 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 package contient tout le contenu sous le chemin d’accès racine.

Vous pouvez définir une ou plusieurs définitions de filtre pour un package. Utilisez plusieurs filtres de manière à inclure le contenu de différents chemins d’accès racine.

Lors de la création de règles, vous définissez une expression régulière (également appelée regex, regexp ou expression rationnelle) pour spécifier tous les nœuds que vous souhaitez inclure ou exclure.

Les filtres de package sont le plus souvent définis lors de la première création du package. Cependant, ils peuvent également être modifiés ultérieurement. Le package devra alors être recréé pour mettre à jour son contenu en fonction des nouvelles définitions de filtre.

Dépendances dependencies

Paramètres avancés advanced-settings

Captures d’écran des packages package-screenshots

Vous pouvez joindre plusieurs captures dʼécran à votre package pour fournir une représentation visuelle de la façon dont le contenu apparaît.

Actions de package package-actions

De nombreuses actions peuvent être entreprises sur un package.

Création d’un package creating-a-new-package

Il n’est pas obligatoire de concevoir immédiatement le package après lʼavoir créé. Un package non conçu ne contient aucun contenu et se compose uniquement des données du filtre et des autres métadonnées.

Concevoir un package building-a-package

Un package est souvent conçu au moment où vous créez le package, mais vous pouvez y revenir ultérieurement pour concevoir ou reconcevoir le package. Cela peut s’avérer utile si le contenu du référentiel ou les filtres du package ont été modifiés.

Modifier un package edit-package

Une fois quʼun package est téléchargé dans AEM, vous pouvez modifier ses paramètres.

En fonction des modifications que vous avez apportées, vous devrez peut-être concevoir à nouveau le package pour mettre à jour son contenu.

Réencapsuler un package rewrapping-a-package

Une fois qu’un package a été créé, il peut être réencapsulé. La réencapsulation modifie les informations du package telles que la miniature, la description, etc., sans toucher à son contenu.

Afficher d’autres versions de package other-versions

Comme chaque version d’un package apparaît dans la liste comme n’importe quel autre package, le gestionnaire de packages peut trouver d’autres versions d’un package sélectionné.

Afficher le contenu du package et test de l’installation viewing-package-contents-and-testing-installation

Une fois un package créé, vous pouvez afficher son contenu.

Télécharer des packages sur votre système de fichiers downloading-packages-to-your-file-system

Partage d’un package share

Le partage de packages était un service public centralisé pour distribuer des packages de contenu. Le partage de packages a été remplacé par la Distribution logicielle et ce bouton ne fonctionne plus.

Chargement des packages à partir du système de fichiers uploading-packages-from-your-file-system

Le contenu du package existe désormais sur AEM, mais pour rendre le contenu disponible, veillez à installer le package.

Validation de packages validating-packages

Les packages pouvant modifier le contenu existant, il est souvent utile de valider ces modifications avant de les installer.

Options de validation validation-options

Le gestionnaire de packages peut effectuer les validations suivantes :

Valider les importations de packages OSGi osgi-package-imports

Éléments inspectés

Cette validation inspecte le package 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.

Établissement des rapports

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 packages.

États d’erreur

Si les dépendances ne sont pas satisfaites, les lots OSGi du package 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.

Valider les recouvrements overlays

Éléments inspectés

Cette validation détermine si le package en cours d’installation contient un fichier qui est 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 package contenant /libs/sling/servlet/errorhandler/404.jsp, il modifiera donc le fichier existant dans /libs/sling/servlet/errorhandler/404.jsp.

Établissement des rapports

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

États d’erreur

Un état d’erreur signifie que le package tente de déployer un fichier déjà recouvert. Par conséquent, les modifications du package seront 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.

Valider les ACL acls

Éléments inspectés

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

Établissement des rapports

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

États d’erreur

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

Résolution d’erreurs

À l’aide des informations fournies par la validation, les nœuds concernés peuvent être examinés dans CRXDE et les listes de contrôle d’accès peuvent être ajustées dans le package, le cas échéant.

Exécuter la validation performing-validation

La validation des packages peut se faire de deux manières différentes :

La validation doit toujours avoir lieu après le chargement du package, mais avant son installation.

Validation de packages via le Gestionnaire de packages via-package-manager

Validation de packages via une requête HTTP POST via-post-request

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 :

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.

Affichage de la couverture du package package-coverage

Les packages sont définis par leurs filtres. Vous pouvez demander au Gestionnaire de packages d’appliquer les filtres d’un package 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 package.

Installation des packages installing-packages

Le chargement d’un package ajoute uniquement le contenu du package au référentiel, mais il n’est pas accessible. Installez le package chargé pour utiliser son contenu.

Avant l’installation de votre package, le Gestionnaire de packages crée automatiquement un package instantané qui contient le contenu qui sera remplacé. Cet instantané est réinstallé lorsque vous désinstallez le package.

Une fois l’installation terminée et réussie, la liste des packages est mise à jour et le mot Installé apparaît dans le statut du package.

Réinstaller les packages reinstalling-packages

La réinstallation des packages effectue les mêmes étapes sur un package déjà installé que celle traitées lors de l’installation initiale du package.

Chargement et installation basés sur le système de fichiers file-system-based-upload-and-installation

Vous pouvez complètement renoncer au gestionnaire de packages lors de l’installation de packages. AEM peut détecter les packages placés à un emplacement spécifique du système de fichiers local de l’ordinateur hôte et les charger et installer automatiquement.

Si l’instance est en cours d’exécution, le chargement et l’installation démarrent immédiatement lorsque vous l’ajoutez au package dans le dossier install.

Si l’instance n’est pas en cours d’exécution, les packages placés dans le dossier install sont installés au démarrage par ordre alphabétique.

Désinstaller les packages uninstalling-packages

La désinstallation d’un package ramène le contenu du référentiel à l’instantané réalisé automatiquement par le gestionnaire de packages avant l’installation.

Supprimer des packages deleting-packages

La suppression d’un package supprime uniquement ses détails du gestionnaire de packages. Si ce package a déjà été installé, le contenu installé n’est pas supprimé.

Répliquer les packages replicating-packages

Répliquez le contenu d’un package afin de l’installer dans l’instance de publication.

Distribution logicielle software-distribution

Les packages 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 packages AEM.

Pour plus d’informations, consultez la documentation sur la distribution logicielle.