Configurations et l’explorateur de configurations

Les configurations AEM permettent de gérer les paramètres dans AEM et servent d’espaces de travail.

Qu’est-ce qu’une configuration ?

Une configuration peut être considérée sous deux angles différents.

• Un administrateur utilise des configurations comme espaces de travail dans AEM afin de définir et de gérer des groupes de paramètres.
• Un développeur utilise le mécanisme de configuration sous-jacent qui implémente des configurations pour conserver et rechercher des paramètres dans AEM.

En résumé, du point de vue d’un administrateur, les configurations sont la manière dont vous créez des espaces de travail pour gérer les paramètres dans AEM, tandis que le développeur doit comprendre comment AEM utilise et gère ces configurations dans le référentiel.

Quelle que soit votre perspective, les configurations répondent à deux objectifs principaux dans AEM :

• Les configurations activent certaines fonctionnalités pour certains groupes d’utilisateurs.
• Les configurations définissent les droits d’accès pour ces fonctionnalités.

Configurations en tant qu’administrateur

L’administrateur AEM ainsi que les auteurs peuvent considérer les configurations comme des espaces de travail. Ces espaces de travail peuvent être utilisés pour rassembler des groupes de paramètres ainsi que leur contenu associé à des fins d’organisation en implémentant des droits d’accès pour ces fonctionnalités.

Des configurations peuvent être créées pour de nombreuses fonctionnalités différentes dans AEM.

• Configurations de cloud
• Segments Context Hub
• Modèles de fragment de contenu
• Modèles modifiables

Exemple

Par exemple, un administrateur peut créer deux configurations pour les modèles modifiables.

• WKND-General
• WKND-Magazine

L’administrateur peut alors créer des modèles de page généraux à l’aide de la configuration WKND-General, puis des modèles spécifiques au magazine sous WKND-Magazine.

L’administrateur peut alors associer le WKND-General à tout le contenu du site WKND. Cependant, la configuration WKND-Magazine ne serait associée qu’au site du magazine.

En procédant comme suit :

• Lorsqu’un auteur de contenu crée une nouvelle page pour le magazine, il peut choisir entre des modèles généraux (WKND-General) et des modèles de magazine (WKND-Magazine).
• Lorsqu’un auteur de contenu crée une nouvelle page pour une autre partie du site qui n’est pas le magazine, il peut uniquement choisir parmi les modèles généraux (WKND-General).

Des configurations similaires sont possibles non seulement pour les modèles modifiables, mais également pour les configurations de cloud, les segments ContextHub et les modèles de fragments de contenu.

Utilisation de l’explorateur de configurations

L’explorateur de configurations permet à un administrateur de créer, gérer et configurer facilement des droits d’accès aux configurations dans AEM.

Création d’une configuration

Il est très simple de créer une nouvelle configuration dans AEM à l’aide de l’explorateur de configurations.

1. Connectez-vous à AEM as a Cloud Service et dans le menu principal, sélectionnez Outils -> Général -> Explorateur de configurations.

2. Appuyez ou cliquez sur Créer.

3. Indiquez un Titre et un Nom pour votre configuration.

   

   • Le Titre doit être descriptif.
   • Le Nom devient le nom du nœud dans le référentiel.
     • Il sera généré automatiquement en fonction du titre et adapté selon les conventions d’appellation AEM.
     • Il peut être adapté si nécessaire.

4. Vérifiez le type de configuration que vous souhaitez autoriser.

   • Configurations de cloud
   • Segments Context Hub
   • Modèles de fragment de contenu
   • Modèles modifiables

5. Appuyez ou cliquez sur Créer.

Modification des configurations et de leurs droits d’accès

Si vous considérez les configurations comme des espaces de travail, les droits d’accès peuvent être définis sur ces configurations afin de définir qui peut ou non accéder à ces espaces de travail.

1. Connectez-vous à AEM as a Cloud Service et dans le menu principal, sélectionnez Outils -> Général -> Explorateur de configurations.

2. Sélectionnez la configuration à modifier, puis appuyez ou cliquez sur Propriétés dans la barre d’outils.

3. Sélectionnez les fonctionnalités supplémentaires que vous souhaitez ajouter à la configuration.

   REMARQUE

   Il n’est pas possible de désélectionner une fonction une fois la configuration créée.

4. Utilisez le bouton Autorisations en vigueur pour afficher une matrice des rôles et les autorisations actuellement accordées aux configurations.
   

5. Pour attribuer de nouvelles autorisations, saisissez le nom de l’utilisateur ou du groupe dans le champ Sélectionner un utilisateur ou un groupe de la section Ajouter de nouvelles autorisations.

   • Le champ Sélectionner un utilisateur ou un groupe peut être renseigné par saisie semi-automatique en fonction des utilisateurs et des rôles existants.

6. Sélectionnez l’utilisateur ou le rôle approprié dans les résultats de saisie semi-automatique.

   • Vous pouvez sélectionner plusieurs utilisateurs ou rôles.

7. Vérifiez les options d’accès que les utilisateurs ou rôles sélectionnés doivent avoir et cliquez sur Ajouter.
   

8. Répétez les étapes pour sélectionner des utilisateurs ou des rôles et attribuer des droits d’accès supplémentaires si nécessaire.

9. Appuyez ou cliquez sur Enregistrer et fermer une fois terminé.

Configurations en tant que développeur

En tant que développeur, il est important de savoir comment AEM as a Cloud Service fonctionne avec les configurations et traite la résolution de configurations.

Séparation de la configuration et du contenu

Bien que l’administrateur et les utilisateurs puissent considérer les configurations comme des espaces de travail pour gérer différents paramètres et contenus, il est important de comprendre que les configurations et le contenu sont stockés et gérés séparément par AEM dans le référentiel.

• /content abrite tout le contenu.
• /conf abrite l’ensemble de la configuration.

Le contenu fait référence à sa configuration associée par le biais d’une propriété cq:conf. AEM effectue une recherche en fonction du contenu et de sa propriété contextuelle cq:conf pour trouver la configuration appropriée.

Exemple

Dans cet exemple, supposons que vous ayez du code d’application concernant les paramètres de la gestion des actifs numériques.

Conf conf = resource.adaptTo(Conf.class);
ValueMap imageServerSettings = conf.getItem("dam/imageserver");
String bgkcolor = imageServerSettings.get("bgkcolor", "FFFFFF");

Le point de départ de toute recherche de configuration est une ressource de contenu, généralement située sous /content. Il peut s’agir d’une page, d’un composant au sein d’une page, d’une ressource ou d’un dossier de la gestion des actifs numériques. Le contenu réel pour lequel nous recherchons la configuration appropriée s’applique dans ce contexte.

Maintenant, avec l’objet Conf, nous pouvons récupérer l’élément de configuration spécifique qui nous intéresse. Dans ce cas, il s’agit de dam/imageserver, qui est un ensemble de paramètres associés à imageserver. L’appel getItem renvoie une ValueMap. Nous lisons ensuite une propriété de chaîne bgkcolor et fournissons une valeur par défaut de « FFFFFF » au cas où la propriété (ou l’élément de configuration complet) ne serait pas présent.

Examinons maintenant le contenu JCR correspondant :

/content/dam/wknd
    + jcr:content
      - cq:conf = "/conf/wknd"
    + image.png [dam:Asset]

/conf/wkns
    + settings
      + dam
        + imageserver [cq:Page]
          + jcr:content
            - bgkcolor = "FF0000"

Dans cet exemple, nous supposons un dossier de la gestion des actifs numériques spécifique à WKND et une configuration correspondante. À partir de ce dossier /content/dam/wknd, nous verrons qu’il existe une propriété de chaîne nommée cq:conf qui fait référence à la configuration qui doit s’appliquer à la sous-arborescence. La propriété est généralement définie sur le jcr:content d’une page ou d’un dossier de ressources. Ces liens conf sont explicites. Il est donc facile de les suivre en regardant simplement le contenu dans CRXDE.

En passant dans /conf, nous suivons la référence et voyons qu’il y a un nœud /conf/wknd. Il s’agit d’une configuration. Sa recherche est totalement transparente par rapport au code d’application. L’exemple de code n’a jamais de référence dédiée. Il est masqué derrière l’objet Conf. La configuration qui s’applique est entièrement contrôlée par le contenu JCR.

Nous voyons que la configuration contient un nœud settings de nom fixe qui contient les éléments réels, y compris dam/imageserver dont nous avons besoin dans notre cas. Un tel élément peut être considéré comme un « document de paramètres » et est généralement représenté par une cq:Page avec un jcr:content contenant le contenu réel.

Nous voyons ensuite la propriété bgkcolor dont notre exemple de code a besoin. La ValueMap que nous récupérons dans getItem repose sur le nœud jcr:content de la page.

Résolution de la configuration

L’exemple de base ci-dessus montrait une configuration unique. Mais dans de nombreux cas, on a besoin de différentes configurations, comme une configuration globale par défaut, une configuration différente pour chaque marque et peut-être une configuration spécifique pour les sous-projets.

Pour ce faire, la recherche de configuration dans AEM dispose d’un mécanisme d’héritage et de repli dans l’ordre de préférence suivant :

1. /conf/<siteconfig>/<parentconfig>/<myconfig>
   • Configuration spécifique référencée à partir de cq:conf quelque part dans /content
   • La hiérarchie est arbitraire et peut être conçue tout comme la structure de votre site. Ce n’est pas au code de l’application de le savoir
   • Modifiable au moment de l’exécution par les utilisateurs disposant de privilèges de configuration
2. /conf/<siteconfig>/<parentconfig>
   • Parcourir les parents pour les configurations de repli
   • Modifiable au moment de l’exécution par les utilisateurs disposant de privilèges de configuration
3. /conf/<siteconfig>
   • Parcourir les parents pour les configurations de repli
   • Modifiable au moment de l’exécution par les utilisateurs disposant de privilèges de configuration
4. /conf/global
   • Paramètres globaux du système
   • Valeurs par défaut généralement globales pour votre installation
   • Défini par un rôle admin
   • Modifiable au moment de l’exécution par les utilisateurs disposant de privilèges de configuration
5. /apps
   • Valeurs par défaut de l’application
   • Corrigé par le déploiement des applications
   • Lecture seule au moment de l’exécution
6. /libs
   • Paramètres par défaut du produit AEM
   • Uniquement modifiable par Adobe, accès au projet non autorisé
   • Corrigé par le déploiement des applications
   • Lecture seule au moment de l’exécution

Utilisation des configurations

Les configurations dans AEM reposent sur les configurations basées sur le contexte Sling. Les lots Sling fournissent une API de service qui peut être utilisée pour obtenir des configurations basées sur le contexte. Les configurations basées sur le contexte sont des configurations qui sont liées à une ressource de contenu ou à une arborescence de ressources, comme décrit dans l’exemple précédent.

Pour plus d’informations sur les configurations basées sur le contexte, des exemples et leur utilisation, consultez la documentation Sling.

Console Web ConfMgr

À des fins de débogage et de test, une console Web ConfMgr dans https://<host>:<port>/system/console/conf peut afficher des configurations pour un chemin/élément donné.

Indiquez simplement :

• Content Path (Chemin d’accès au contenu)
• Item (Élément)
• User (Utilisateur)

Cliquez sur Resolve (Résoudre) pour voir quelles configurations sont résolues et recevoir un exemple de code qui résoudra ces configurations.

Console Web de configuration basée sur le contexte

À des fins de débogage et de test, une console Web de configuration basée sur le contexte dans https://<host>:<port>/system/console/slingcaconfig permet d’interroger des configurations basées sur le contexte dans le référentiel et d’afficher leurs propriétés.

Indiquez simplement :

• Content Path (Chemin d’accès au contenu)
• Config Name (Nom de configuration)

Cliquez sur Resolve (Résoudre) pour récupérer les chemins d’accès au contexte et propriétés associés pour la configuration sélectionnée.