Personnalisation de la console Sites web (IU classique)

Ajout d’une colonne personnalisée à la console Sites web (siteadmin)

La console Administration de sites web peut être étendue pour afficher des colonnes personnalisées. La console est générée sur la base d’un objet JSON qui peut être étendu en créant un service OSGI qui implémente l’interface . ListInfoProvider Un tel service modifie l’objet JSON envoyé au client pour créer la console.

Ce tutoriel détaillé explique comment afficher une nouvelle colonne dans la console Administration de sites web en implémentant l’interface ListInfoProvider. Cette méthode comprend les étapes suivantes :

1. Création du service OSGI et déploiement du lot où il réside sur le serveur AEM.
2. (Facultatif) Test du nouveau service en effectuant un appel JSON pour demander l’objet JSON qui est utilisé pour créer la console.
3. Affichage de la nouvelle colonne en étendant la structure des nœuds de la console dans le référentiel.

Création du service OSGI

L’interface ListInfoProvider définit deux méthodes :

• updateListGlobalInfo, pour mettre à jour les propriétés globales de la liste,
• updateListItemInfo, pour mettre à jour un seul élément de liste.

Les arguments pour les deux méthodes sont les suivants :

• request, l’objet de requête HTTP Sling associé,
• info, l’objet JSON à mettre à jour, à savoir la liste globale ou l’élément de liste en cours,
• resource, une ressource Sling.

L’exemple d’implémentation ci-dessous :

• ajoute une propriété starred pour chaque élément, à savoir true si le nom de page commence par un e et false dans les autres cas ;

• ajoute une propriété starredCount qui est « global » pour la liste et qui contient le nombre d’éléments de liste signalés par un astérisque.

Pour créer le service OSGI, procédez comme suit :

1. Dans CRXDE Lite, créez un lot.
2. Ajoutez l’exemple de code ci-dessous.
3. Créez le lot.

Le nouveau service est opérationnel.

package com.test;

import com.day.cq.commons.ListInfoProvider;
import com.day.cq.i18n.I18n;
import com.day.cq.wcm.api.Page;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;

@Component(metatype = false)
@Service(value = ListInfoProvider.class)
public class StarredListInfoProvider implements ListInfoProvider {

    private int count = 0;

    public void updateListGlobalInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        info.put("starredCount", count);
        count = 0; // reset for next execution
    }

    public void updateListItemInfo(SlingHttpServletRequest request, JSONObject info, Resource resource) throws JSONException {
        Page page = resource.adaptTo(Page.class);
        if (page != null) {
            // Consider starred if page name starts with 'e'
            boolean starred = page.getName().startsWith("e");
            if (starred) {
                count++;
            }
            I18n i18n = new I18n(request);
            info.put("starred", starred ? i18n.get("Yes") : i18n.get("No"));
        }
    }

}

Test du nouveau service

Lorsque vous ouvrez la console Administration de sites web et parcourez votre site, le navigateur génère un appel ajax pour obtenir l’objet JSON qui est utilisé pour créer la console. Par exemple, lorsque vous accédez au dossier /content/geometrixx, la requête suivante est envoyée au serveur AEM pour créer la console :

http://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

Pour vous assurer que le nouveau service s’exécute après le déploiement du lot où il réside, procédez comme suit :

1. Pointez votre navigateur sur l’URL suivante :

   http://localhost:4502/content/geometrixx.pages.json?start=0&limit=30&predicate=siteadmin

2. La réponse doit afficher les nouvelles propriétés comme suit :

Affichage de la nouvelle colonne

La dernière étape consiste à adapter la structure des noeuds de la console d'administration des sites Web pour afficher la nouvelle propriété pour toutes les pages de Geometrixx en superposant /libs/wcm/core/content/siteadmin. Procédez comme suit :

1. En CRXDE Lite, créez la structure des noeuds /apps/wcm/core/content avec des noeuds de type sling:Folder pour refléter la structure /libs/wcm/core/content.

2. Copiez le noeud /libs/wcm/core/content/siteadmin et collez-le sous /apps/wcm/core/content.

3. Copiez le noeud /apps/wcm/core/content/siteadmin/grid/assets dans /apps/wcm/core/content/siteadmin/grid/geometrixx et modifiez ses propriétés :

   • Supprimez pageText

   • Définissez pathRegex sur /content/geometrixx(/.*?lang=fr)?

     De cette manière, la configuration de grille sera active pour tous les sites web geometrixx.

   • Définissez storeProxySuffix sur .pages.json

   • Modifiez la propriété à plusieurs valeurs storeReaderFields et ajoutez la valeur starred.

   • Pour activer la fonctionnalité MSM, ajoutez les paramètres MSM suivants à la propriété multichaîne storeReaderFields :

     • msm:isSource
     • msm:isInBlueprint
     • msm:isLiveCopy

4. Ajoutez un noeud starred (de type nt:unstructured) sous /apps/wcm/core/content/siteadmin/grid/geometrixx/columns avec les propriétés suivantes :

   • dataIndex : starred de type chaîne
   • en-tête : Starred de type chaîne
   • xtype : gridcolumn de type chaîne

5. (Facultatif) Déposez les colonnes que vous ne souhaitez pas afficher à /apps/wcm/core/content/siteadmin/grid/geometrixx/columns

6. /siteadmin est un chemin de vanité qui, par défaut, pointe vers /libs/wcm/core/content/siteadmin.

   Pour rediriger ceci vers votre version de siteadmin sur /apps/wcm/core/content/siteadmin, définissez la propriété sling:vanityOrder pour qu'elle ait une valeur supérieure à celle définie sur /libs/wcm/core/content/siteadmin. La valeur par défaut est de 300 ; toute valeur plus élevée est donc acceptable.

7. Accédez à la console d’administration des sites Web et accédez au site Geometrixx :

   http://localhost:4502/siteadmin#/content/geometrixx.

8. La nouvelle colonne nommée Starred affiche des informations personnalisées comme suit :

Exemple de module

Le résultat de ce didacticiel est disponible dans le package Personnalisation du module Administration Console des sites Web sur le partage de package.