Documentation AEM 6.4 Guide de développement

Créer des sites adaptés aux appareils mobiles creating-sites-for-mobile-devices

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
Developing

Créé pour :

Developer

CAUTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

NOTE

Adobe recommande d’utiliser l’éditeur d’application d’une seule page (SPA) pour les projets nécessitant un rendu côté client basé sur la structure SPA (par exemple, React). En savoir plus.

La création d’un site mobile est similaire à celle d’un site classique en ce sens qu’il faut également créer des modèles et des composants. Pour plus de détails sur la création de modèles et de composants, reportez-vous aux pages suivantes : Modèles, Composants et Prise en main du développement d’AEM Sites. La principale différence entre les deux consiste à activer les fonctionnalités mobiles intégrées d’AEM sur le site. Pour ce faire, créez un modèle qui repose sur le composant de page mobile.

Pensez également à utiliser responsive design, créant un site unique prenant en charge plusieurs tailles d’écran.

Pour commencer, vous pouvez consulter le Site de démonstration mobile We.Retail qui est disponible dans AEM.

Pour créer un site mobile, procédez comme suit :

Créez le composant de page :
- Définissez la propriété sling:resourceSuperType sur wcm/mobile/components/page.
  
  Ainsi, le composant repose sur le composant de page mobile.
- Créez le body.jsp avec la logique spécifique au projet.
Créez le modèle de page :
- Définissez la propriété sling:resourceType sur le composant de page nouvellement créé.
- Définissez la propriété allowedPaths.
Créez la page de conception pour le site.
Créez la page racine du site sous le nœud /content :
- Définissez la propriété cq:allowedTemplates.
- Définissez la propriété cq:designPath.
Dans les propriétés de page de la page racine du site, définissez les groupes d’appareils dans l’onglet Mobile.
Créez les pages du site en vous servant du nouveau modèle.

Le composant de page mobile (/libs/wcm/mobile/components/page) :

Ajoute l’onglet Mobile à la boîte de dialogue des propriétés de la page.
Grâce à son head.jsp, il extrait le groupe d’appareils mobiles actuel de la requête et, si un groupe d’appareils est identifié, il utilise la méthode drawHead() du groupe pour ajouter le composant d’initialisation de l’émulateur associé du groupe d’appareils (uniquement en mode de création) et le rendu CSS du groupe d’appareils.

NOTE

La page racine du site mobile doit être au niveau 1 de la hiérarchie des nœuds et il est recommandé de se placer sous le nœud /content.

Création d’un site mobile avec le Multi Site Manager creating-a-mobile-site-with-the-multi-site-manager

Utilisez Multi Site Manager (MSM) pour créer une Live Copy mobile à partir d’un site classique. Celui-ci est automatiquement transformé en site mobile qui possède toutes les fonctionnalités des sites mobiles (par exemple, modification dans un émulateur) et peut être géré en synchronisation avec le site classique. Reportez-vous à la section Création d’une Live Copy pour différents canaux de la page Multi-Site Manager.

API mobile côté serveur server-side-mobile-api

Les packages Java contenant les classes mobiles sont les suivants :

com.day.cq.wcm.mobile.api - Définit MobileConstants.
com.day.cq.wcm.mobile.api.device - Définit Device, DeviceGroup et DeviceGroupList.
com.day.cq.wcm.mobile.api.device.capability - Définit DeviceCapability.
com.day.cq.wcm.mobile.api.wurfl - Définit WurflQueryEngine.
com.day.cq.wcm.mobile.core - Définit MobileUtil, qui fournit diverses méthodes utilitaires relatives à WCM Mobile.

Composants mobiles mobile-components

Le site mobile de démonstration We.Retail utilise les composants mobiles suivants, situés sous /libs/foundation/components :

Nom

Groupe

Caractéristiques

mobilefooter

caché

- Pied de page

mobileimage

Mobile

- Basé sur le composant de base d’image
- Effectue le rendu d’une image si l’appareil en est capable

mobilelist

Mobile

- Basé sur le composant list foundation
- listitem_teaser.jsp effectue le rendu d’une image si l’appareil en est capable

mobilelogo

caché

- Basé sur le composant de base du logo
- effectue le rendu d’une image si l’appareil en est capable

mobilereference

Mobile

- Similaire au composant de base de référence

- Mappe un composant textimage à un composant mobiletextimage et un composant image à un élément mobileimage

mobiletextimage

Mobile

- Basé sur le composant textimage foundation
- Effectue le rendu d’une image si l’appareil en est capable

mobiletopnav

caché

- Basé sur le composant topnav foundation

- Effectue uniquement le rendu du texte

Création d’un composant mobile creating-a-mobile-component

Le framework AEM Mobile permet de développer des composants sensibles au type d’appareil émettant la requête. Les exemples de code suivants montrent comment utiliser l’API mobile AEM dans un composant jsp et en particulier comment exécuter les actions suivantes :

Récupérer la classe d’appareil à partir de la requête :

Device device = slingRequest.adaptTo(Device.class);
Récupérer le groupe d’appareils :

DeviceGroup deviceGroup = device.getDeviceGroup();
Récupérer les fonctions du groupe d’appareils :

Collection<DeviceCapability> capabilities = deviceGroup.getCapabilities();
Récupérer les attributs de l’appareil (paire clé/valeur de fonction brute issue de la base de données WURFL) :

Map<String,String> deviceAttributes = device.getAttributes();
Récupérer le User-Agent de l’appareil :

String userAgent = device.getUserAgent();
Récupérer la liste des groupes d’appareils (groupes d’appareils affectés au site par l’auteur) à partir de la page active :

DeviceGroupList deviceGroupList = currentPage.adaptTo(DeviceGroupList.class);
Vérifier si le groupe d’appareils prend en charge les images :

if (deviceGroup.hasCapability(DeviceCapability.CAPABILITY_IMAGES)) {
…
OR
if MobileUtil.hasCapability(request, DeviceCapability.CAPABILITY_IMAGES) {
…

NOTE

Dans un fichier jsp, slingRequest est disponible avec la balise <sling:defineObjects> et currentPage avec la balise <cq:defineObjects>.

Émulateurs emulators

La création basée sur émulateur permet aux auteurs de créer des pages de contenu compatibles avec des clients mobiles. La création de contenu mobile suit le même principe que l’édition WYSIWYG locale. Pour que les auteurs puissent faire l’expérience du rendu de la page sur un appareil mobile, une page de contenu mobile est modifiée à l’aide d’un émulateur d’appareil.

Les émulateurs d’appareils mobiles sont basés sur un framework d’émulation générique. Pour plus de détails, reportez-vous à la page Émulateurs.

L’émulateur affiche l’appareil mobile sur la page pendant que les modifications normales (parsys, composants) sont apportées sur l’écran de l’appareil. Le type d’émulateur dépend des groupes d’appareils configurés pour le site. Plusieurs émulateurs peuvent être affectés à un seul groupe d’appareils. Tous les émulateurs sont alors disponibles sur la page de contenu. Par défaut, le premier émulateur affecté au premier groupe d’appareils attribué au site est affiché. Les émulateurs peuvent être activés au moyen du carrousel d’émulateurs en haut de la page ou avec le bouton de modification du sidekick.

Création d’un émulateur

Pour créer un émulateur, reportez-vous à la section Création d’un émulateur mobile personnalisé de la page Émulateurs.

Principales caractéristiques des émulateurs mobiles

Un groupe d’appareils est composé d’un ou de plusieurs émulateurs : la page de configuration du groupe d’appareils, par ex. /etc/mobile/groups/touch, contient la propriété emulators sous le nœud jcr:content.

Remarque : Bien que le même émulateur puisse être affecté à plusieurs groupes d’appareils, ce n’est pas très logique.
Dans la boîte de dialogue de configuration du groupe d’appareils, la propriété emulators est définie avec le chemin du ou des émulateurs souhaités. Par exemple : /libs/wcm/mobile/components/emulators/iPhone4.
Les composants de l’émulateur (par exemple, /libs/wcm/mobile/components/emulators/iPhone4) étendent le composant de l’émulateur mobile de base (/libs/wcm/mobile/components/emulators/base).
Chaque composant qui étend l’émulateur mobile de base peut être sélectionné lors de la configuration d’un groupe d’appareils. Les émulateurs personnalisés peuvent ainsi être facilement créés ou étendus.
Au moment de la demande en mode d’édition, l’implémentation de l’émulateur est utilisée pour effectuer le rendu de la page.
Lorsque le modèle de la page repose sur le composant de page mobile, les fonctionnalités de l’émulateur sont automatiquement intégrées dans la page (via le head.jsp du composant de page mobile).

Groupes de périphériques device-groups

Les groupes d’appareils mobiles fournissent une segmentation des appareils mobiles selon les caractéristiques fonctionnelles de chaque appareil. Un groupe d’appareils fournit les informations nécessaires à la création par émulateur sur l’instance de création et au rendu correct sur l’instance de publication : une fois que les auteurs ont ajouté du contenu à la page mobile et l’ont publié, la page peut être demandée sur l’instance de publication. Sur cette instance, au lieu de la vue en mode de modification de l’émulateur, la page de contenu est rendue selon l’un des groupes d’appareils configurés. La sélection du groupe d’appareils se fait en fonction de la détection des appareils mobiles. Le groupe d’appareils correspondant fournit ensuite les informations de style nécessaires.

Les groupes d’appareils sont définis comme des pages de contenu /etc/mobile/devices et utilisent le modèle Groupe de périphériques mobiles. Celui-ci sert de modèle de configuration pour les définitions de groupe d’appareils sous la forme de pages de contenu. Ses caractéristiques principales sont les suivantes :

Emplacement : /libs/wcm/mobile/templates/devicegroup
Chemin d’accès autorisé : /etc/mobile/groups/*
Composant de page : wcm/mobile/components/devicegroup

Affectation de groupes d’appareils à votre site assigning-device-groups-to-your-site

Lorsque vous créez un site mobile, vous devez affecter des groupes d’appareils au site. AEM fournit trois groupes d’appareils en fonction des capacités de HTML et de rendu JavaScript de l’appareil :

Fonctionnalité téléphones, pour les appareils comme le Sony Ericsson W800 avec prise en charge du HTML de base, mais pas des images et de JavaScript.
Smartphones pour les appareils comme le Blackberry avec prise en charge du HTML basique et des images, mais pas de JavaScript.
Appareils tactiles pour les tablettes comme l’iPad avec prise en charge complète du HTML, des images, de JavaScript et de la rotation des appareils.

Dans la mesure où les émulateurs peuvent être associés à un groupe d’appareils (voir la section Création d’un groupe d’appareils), l’affectation d’un groupe d’appareils à un site permet aux auteurs de sélectionner les émulateurs associés au groupe d’appareils pour modifier la page.

Pour affecter un groupe d’appareils à votre site :

Dans votre navigateur, accédez au Siteadmin console.
Ouvrez la page racine de votre site mobile ci-dessous. Sites web.
Ouvrez les propriétés de la page.
Sélectionnez la Mobile tab :
- Définissez les groupes d’appareils.
- Cliquez sur OK.

NOTE

Lorsque les groupes d’appareils ont été définis pour un site, ils sont hérités par toutes les pages du site.

Filtres du groupe de périphériques device-group-filters

Les filtres de groupe d’appareils définissent des critères fonctionnels pour déterminer si un appareil appartient ou non à un groupe. Lorsque vous créez un groupe d’appareils, vous pouvez sélectionner les filtres à utiliser pour évaluer les appareils.

Au moment de l’exécution, quand AEM reçoit une requête HTTP d’un appareil, chaque filtre associé à un groupe compare les caractéristiques de l’appareil avec des critères spécifiques. L’appareil est considéré comme appartenant au groupe lorsqu’il possède toutes les caractéristiques que le filtre impose. Les caractéristiques sont extraites de la base de données WURFL™.

Les groupes d’appareils peuvent utiliser aucun ou plusieurs filtres pour la détection des caractéristiques. De plus, un filtre peut être utilisé avec plusieurs groupes d’appareils. AEM fournit un filtre par défaut qui détermine si l’appareil dispose des fonctionnalités sélectionnées pour un groupe :

CSS
Images JPG et PNG
JavaScript
Rotation de l’appareil

Si le groupe d’appareils n’utilise pas de filtre, les caractéristiques sélectionnées configurées pour le groupe sont les seules que l’appareil doit posséder.

Pour plus d’informations, consultez la section Création de filtres de groupes d’appareils.

Création d’un groupe d’appareils creating-a-device-group

Créez un groupe d’appareils lorsque les groupes AEM installés ne répondent pas à vos besoins.

Dans votre navigateur, accédez au Outils console.
Créez une page sous Outils > Mobile >Groupes de périphériques. Dans la boîte de dialogue Créer une page :
- Comme Titre, entrez Special Phones.
- Comme Nom, entrez special.
- Sélectionnez la Modèle Groupe d’appareils mobiles.
- Cliquez sur Créer.
Dans CRXDE, ajoutez un fichier static.css contenant les styles du groupe d’appareils sous le nœud /etc/mobile/groups/special.
Ouvrez la page Special Phones.
Pour configurer le groupe d’appareils, cliquez sur le bouton Modifier à côté de Paramètres.

Dans l’onglet Général :
- Titre : nom du groupe d’appareils mobiles
- Description: description du groupe.
- User-Agent : chaîne user-agent avec laquelle les appareils sont mappés. Paramètre facultatif qui peut être une expression régulière. Exemple : BlackBerryZ10
- Fonctionnalités: définit si le groupe peut gérer les images, CSS, JavaScript ou la rotation de l’appareil.
- Largeur d’écran minimale et Hauteur
- Désactiver l’émulateur: pour activer/désactiver l’émulateur lors de la modification du contenu.
Sur le Émulateurs tab :
- Émulateurs : sélectionnez les émulateurs affectés à ce groupe d’appareils.
Sur le Filtres tab :
- Pour ajouter un filtre, cliquez sur Ajouter un élément et sélectionnez un filtre dans la liste déroulante.
- Les filtres sont évalués dans l’ordre dans lequel ils apparaissent. Lorsqu’un appareil ne répond pas aux critères d’un filtre, les filtres suivants sur la liste ne sont pas évalués.
Cliquez sur OK.

La boîte de dialogue de configuration de groupe d’appareils mobiles se présente comme suit :

screen_shot_2012-02-01at22043pm

CSS personnalisé par groupe d’appareils custom-css-per-device-group

Comme décrit précédemment, il est possible d’associer une page CSS personnalisée à une page de groupe d’appareils, tout comme le CSS d’une page de conception. Ce CSS est utilisé pour influencer le rendu spécifique au groupe d’appareils du contenu de la page sur l’auteur et sur la publication. Ce CSS est alors automatiquement inclus :

Dans la page de l’instance de création pour chaque émulateur utilisé par ce groupe d’appareils.
dans la page sur l’instance de publication, si la chaîne User-Agent de la requête correspond à un appareil mobile appartenant à ce groupe d’appareils particulier.

Détection des périphériques côté serveur server-side-device-detection

Utilisez des filtres et une bibliothèque de spécifications d’appareil pour déterminer les fonctionnalités de l’appareil qui exécute la requête HTTP.

Développer des filtres de groupe d’appareils develop-device-group-filters

Créez un filtre de groupe d’appareils pour définir un ensemble d’exigences en termes de caractéristiques d’appareil. Créez autant de filtres que nécessaire pour cibler les groupes de fonctionnalités d’appareil nécessaires.

Concevez vos filtres de sorte à pouvoir utiliser des combinaisons pour définir des groupes de caractéristiques. Généralement, certaines caractéristiques sont communes à différents groupes d’appareils. Par conséquent, vous pouvez utiliser certains filtres avec plusieurs définitions de groupe d’appareils.

Après avoir créé un filtre, vous pouvez l’utiliser dans la configuration du groupe.

Pour plus d’informations, voir Création de filtres de groupe d’appareils.

Utilisation de la base de données WURFL™ using-the-wurfl-database

AEM utilise une version tronquée de la base de données WURFL™ pour interroger les caractéristiques des appareils, telles que la résolution d’écran ou la prise en charge de javascript, selon le User-Agent de l’appareil.

Le code XML de la base de données WURFL™ est représenté sous la forme de nœuds sous /var/mobile/devicespecs en analysant le fichier wurfl.xml sous /libs/wcm/mobile/devicespecs/wurfl.xml.. L’extension aux nœuds se produit la première fois que le lot cq-mobile-core est démarré.

Les caractéristiques des appareils sont stockées en tant que propriétés de nœud. Les nœuds représentent les modèles d’appareil. Vous pouvez utiliser des requêtes pour récupérer les fonctionnalités d’un appareil ou d’un agent utilisateur.

Puisque la base de données WURFL™ évolue, il faudra peut-être la personnaliser ou la remplacer. Pour mettre à jour la base de données des périphériques mobiles, vous disposez des options suivantes :

Remplacer le fichier par la dernière version, à condition de posséder une licence qui autorise cette utilisation. Voir Installation d’une autre base de données WURFL.
Utiliser la version disponible dans AEM et configurer une expression régulière qui correspond à vos chaînes User-Agent et pointe vers un appareil WURFL™ existant. Consultez la section Ajout d’un mappage Utilisateur-Agent basé sur une expression régulière.

Test du mappage d’un User-Agent sur les fonctionnalités WURFL™ testing-the-mapping-of-a-user-agent-to-wurfl-capabilities

Lorsqu’un appareil accède à votre site pour appareils mobiles, AEM le détecte, le mappe à un groupe d’appareils d’après ses fonctions et diffuse un rendu de la page qui est adapté au groupe d’appareils. Le groupe d’appareils correspondant fournit les informations de style nécessaires. Les mappages peuvent être testés sur la page de test du User-Agent mobile :

http://localhost:4502/etc/mobile/useragent-test.html

Installation d’une autre base de données WURFL™ installing-a-different-wurfl-database

La base de données WURFL™ tronquée installée avec AEM est une version antérieure aux dates
30 août 2011. Si votre version de WURFL a été publiée après le 30 août 2011, assurez-vous que l’utilisation que vous en faites est conforme à votre licence.

Pour installer une base de données WURFL™, procédez comme suit :

Dans CRXDE Lite, créez le dossier suivant : /apps/wcm/mobile/devicespecs.
Copiez le fichier WURFL™ dans le dossier.
Renommez ce fichier wurfl.xml.

AEM analyse automatiquement le fichier wurfl.xml et met à jour les nœuds /var/mobile/devicespecs.

NOTE

Lorsque la base de données WURFL™ complète est activée, l’analyse et l’activation peuvent prendre quelques minutes. Vous pouvez consulter les journaux pour obtenir des informations de progression.

Ajout d’une correspondance User-Agent basée sur regexp adding-a-regexp-based-user-agent-matching

Ajoutez une chaîne user-agent en tant qu’expression régulière sous /apps/wcm/mobile/devicespecs/wurfl/regexp pour désigner un type d’appareil WURFL™ existant.

Dans CRXDE Lite, créez un noeud sous /apps/wcm/mobile/devicespecs/regexp, par exemple apple_ipad_ver1.
Ajoutez les propriétés suivantes au nœud :
- regexp : expression régulière définissant les user-agents, par exemple :*Mozilla.*iPad.*AppleWebKit.*Safari.*
- deviceId : ID d’appareil tel que défini dans le fichier wurfl.xml, par exemple : apple_ipad_ver1

La configuration ci-dessus provoque le mappage des appareils pour lesquels le user-agent correspond à l’expression régulière fournie avec l’ID d’appareil WURFL™ apple_ipad_ver1, s’il existe.

Détection des périphériques côté client client-side-device-detection

Cette section décrit comment utiliser la détection côté client de l’AEM de l’appareil afin d’optimiser le rendu des pages ou de fournir au client des versions de site web différentes.

AEM prend en charge la détection côté client d’appareils avec BrowserMap. Dans AEM, BrowserMap se présente comme une bibliothèque cliente sous /etc/clientlibs/browsermap.

BrowserMap offre trois alternatives pour fournir un site web secondaire à un client. Elles sont appliquées dans l’ordre suivant :

Des liens secondaires
Une URL spécifique au groupe d’appareils
Une URL basée sur un sélecteur

NOTE

Pour plus d’informations sur l’intégration de la bibliothèque cliente, consultez la section Utilisation de bibliothèques HTML côté client.

Liens secondaires providing-alternate-links

Le service PageVariantsProvider OSGi est capable de générer des liens secondaires pour les sites appartenant à la même famille. Pour configurer les sites concernés par le service, un nœud cq:siteVariant doit être ajouté au nœud jcr:content à la racine du site.

Le nœud cq:siteVariant doit posséder les propriétés suivantes :

cq:childNodesMapTo - Détermine avec quel attribut de l’élément de lien les nœuds enfants seront mappés. Il est recommandé d’organiser le contenu de votre site de manière à ce que les enfants du nœud racine représentent la racine d’une variante de langue de votre site web international (par exemple /content/mysite/de, /content/mysite/en), auquel cas la valeur de cq:childNodesMapTo doit être hreflang.
cq:variantDomain - Indique le domaine Externalizer qui sera utilisé pour générer les URL absolues de variantes de page. Si cette valeur n’est pas définie, les variantes de page sont générées avec des liens relatifs.
cq:variantFamily - Indique à quelle famille de sites appartient ce site. Plusieurs rendus spécifiques à chaque appareil d’un même site web doivent appartenir à la même famille.
media - Stocke les valeurs de l’attribut media de l’élément link. Il est recommandé d’utiliser le nom du BrowserMap enregistré avec DeviceGroups, de sorte que la bibliothèque BrowserMap puisse automatiquement rediriger les clients vers la bonne variante du site web.

PageVariantsProvider et Externalizer pagevariantsprovider-and-externalizer

Lorsque la valeur de la propriété cq:variantDomain d’un nœud cq:siteVariant n’est pas vide, le service PageVariantsProvider génère des liens absolus en utilisant cette valeur en tant que domaine configuré pour le service Externalizer. Assurez-vous de configurer le service Externalizer de manière à tenir compte de votre configuration.

NOTE

Lorsque vous utilisez AEM, plusieurs méthodes permettent de gérer les paramètres de configuration pour ces services. Consultez la section Configuration d’OSGi pour plus de détails et connaître les pratiques recommandées.

Définition d’une URL spécifique à un groupe d’appareils defining-a-device-group-specific-url

Si vous ne souhaitez pas utiliser des liens secondaires, vous pouvez configurer une URL globale pour chaque DeviceGroup. Nous vous recommandons de créer votre propre bibliothèque cliente qui intègre la bibliothèque cliente browsermap.standard mais qui redéfinit les groupes d’appareils.

BrowserMap est conçu de telle sorte que les définitions de groupes d’appareils peuvent être remplacées en créant et en ajoutant un nouveau groupe d’appareils du même nom à l’objet BrowserMap de votre bibliothèque cliente personnalisée.

NOTE

Pour plus d’informations, veuillez lire la section BrowserMap personnalisé .

Définition d’URL basées sur un sélecteur defining-selector-based-urls

Si aucun des mécanismes précédents n’a été utilisé pour indiquer un site secondaire de redirection à BrowserMap, les sélecteurs qui utilisent les noms des DeviceGroups sont ajoutés aux URL, auquel cas vous devez fournir vos propres servlets. Ce sont eux qui géreront les requêtes.

Par exemple, un appareil qui accède à www.example.com/index.html identifié comme un smartphone par BrowserMap est redirigé vers www.example.com/index.smartphone.html..

Utilisation de BrowserMap dans les pages using-browsermap-on-your-pages

Pour utiliser la bibliothèque cliente BrowserMap standard dans une page, vous devez inclure le fichier /libs/wcm/core/browsermap/browsermap.jsp au moyen de la balise cq:include dans la section head de votre page.

<cq:include script="/libs/wcm/core/browsermap/browsermap.jsp" />

Outre l’ajout de la bibliothèque cliente BrowserMap à vos fichiers JSP, vous devez également ajouter une propriété de chaîne cq:deviceIdentificationMode définie sur client-side au nœud jcr:content sous la racine de votre site web.

Remplacement du comportement par défaut de BrowserMap overriding-browsermap-s-default-behavior

Si vous souhaitez personnaliser BrowserMap en remplaçant les DeviceGroups ou en ajoutant d’autres sondes, vous devez créer votre propre bibliothèque côté client à laquelle vous incorporez la bibliothèque côté client browsermap.standard.

De plus, vous devez appeler manuellement la méthode BrowserMap.forwardRequest() dans votre code JavaScript.

NOTE

Pour plus d’informations sur l’intégration de la bibliothèque cliente, consultez la section Utilisation de bibliothèques HTML côté client.

Une fois la bibliothèque cliente BrowserMap personnalisée créée, nous proposons l’approche suivante :

Créez un fichier browsermap.jsp dans votre application.

code language-xml

code language-xml
<%@include file="/libs/foundation/global.jsp" %> <%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %> <%@ page import=" com.day.cq.wcm.api.variants.PageVariant, com.day.cq.wcm.api.variants.PageVariantsProvider, com.day.cq.wcm.api.devicedetection.DeviceIdentificationMode, com.day.cq.wcm.api.WCMMode" %> <% final PageVariantsProvider p = sling.getService(PageVariantsProvider.class); if(p == null) { throw new IllegalStateException("Missing PageVariantsProvider service"); } for(PageVariant v : p.getVariants(currentPage, slingRequest)) { final String curVar = v.getAttributes().get("data-current-variant"); String media = v.getAttributes().get("media"); if (media != null) { media = media.replaceAll(" ", ""); } %> <link rel="alternate" data-cq-role="site.variant" title="<%= xssAPI.encodeForHTMLAttr(v.getTitle()) %>" hreflang="<%= xssAPI.encodeForHTMLAttr(v.getAttributes().get("hreflang")) %>" media="<%= xssAPI.encodeForHTMLAttr(media) %>" href="<%= xssAPI.getValidHref(v.getURL()) %>" <% if(curVar != null) { %> data-current-variant="<%= curVar %>"<% } %> /> <% } Boolean browserMapEnabled = true; final DeviceIdentificationMode dim = sling.getService(DeviceIdentificationMode.class); String[] selectors = slingRequest.getRequestPathInfo().getSelectors(); boolean isPortletRequest = false; for (int i = 0; i < selectors.length; i++) { if ("portlet".equals(selectors[i])) { isPortletRequest = true; break; } } if (isPortletRequest) { log.debug("Request was made by a portlet container - BrowserMap will not be embedded"); } else { final WCMMode wcmMode = WCMMode.fromRequest(slingRequest); boolean shouldIncludeClientLib = false; if (WCMMode.EDIT != wcmMode && WCMMode.PREVIEW != wcmMode && WCMMode.DESIGN != wcmMode) { if (dim != null) { final String mode = dim.getDeviceIdentificationModeForPage(currentPage); shouldIncludeClientLib = DeviceIdentificationMode.CLIENT_SIDE.equals(mode); if (shouldIncludeClientLib) { browserMapEnabled = (Boolean) request.getAttribute("browsermap.enabled"); if (browserMapEnabled == null) { browserMapEnabled = true; } } } } %> <c:if test="<%= !browserMapEnabled %>"> <meta name="browsermap.enabled" content="false"> </c:if> <c:if test="<%= shouldIncludeClientLib %>"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <cq:includeClientLib categories="browsermap.custom"/> </c:if> <% } %>

<%@include file="/libs/foundation/global.jsp" %>
<%@ taglib prefix="c" uri="https://java.sun.com/jsp/jstl/core" %>
<%@ page import="
    com.day.cq.wcm.api.variants.PageVariant,
    com.day.cq.wcm.api.variants.PageVariantsProvider,
    com.day.cq.wcm.api.devicedetection.DeviceIdentificationMode,
    com.day.cq.wcm.api.WCMMode"
%>
<%
    final PageVariantsProvider p = sling.getService(PageVariantsProvider.class);
    if(p == null) {
        throw new IllegalStateException("Missing PageVariantsProvider service");
    }
    for(PageVariant v : p.getVariants(currentPage, slingRequest)) {
        final String curVar = v.getAttributes().get("data-current-variant");
        String media = v.getAttributes().get("media");
        if (media != null) {
            media = media.replaceAll(" ", "");
        }
%>
    <link
        rel="alternate"
        data-cq-role="site.variant"
        title="<%= xssAPI.encodeForHTMLAttr(v.getTitle()) %>"
        hreflang="<%= xssAPI.encodeForHTMLAttr(v.getAttributes().get("hreflang")) %>"
        media="<%= xssAPI.encodeForHTMLAttr(media) %>"
        href="<%= xssAPI.getValidHref(v.getURL()) %>"
        <% if(curVar != null) { %> data-current-variant="<%= curVar %>"<% } %>
    />
<%
    }
    Boolean browserMapEnabled = true;
    final DeviceIdentificationMode dim = sling.getService(DeviceIdentificationMode.class);
    String[] selectors  = slingRequest.getRequestPathInfo().getSelectors();
    boolean isPortletRequest = false;
    for (int i = 0; i < selectors.length; i++) {
        if ("portlet".equals(selectors[i])) {
            isPortletRequest = true;
            break;
        }
    }
    if (isPortletRequest) {
        log.debug("Request was made by a portlet container - BrowserMap will not be embedded");
    } else {
        final WCMMode wcmMode = WCMMode.fromRequest(slingRequest);
        boolean shouldIncludeClientLib = false;
        if (WCMMode.EDIT != wcmMode && WCMMode.PREVIEW != wcmMode && WCMMode.DESIGN != wcmMode) {
            if (dim != null) {
                final String mode = dim.getDeviceIdentificationModeForPage(currentPage);
                shouldIncludeClientLib = DeviceIdentificationMode.CLIENT_SIDE.equals(mode);
                if (shouldIncludeClientLib) {
                    browserMapEnabled = (Boolean) request.getAttribute("browsermap.enabled");
                    if (browserMapEnabled == null) {
                        browserMapEnabled = true;
                    }
                }
            }
        }
%>
        <c:if test="<%= !browserMapEnabled %>">
            <meta name="browsermap.enabled" content="false">
        </c:if>
        <c:if test="<%= shouldIncludeClientLib %>">
            <meta name="viewport" content="width=device-width, initial-scale=1.0">
            <cq:includeClientLib categories="browsermap.custom"/>
        </c:if>
<%
    }
%>

Ajoutez le fichier broswermap.jsp à la section head.

code language-xml
`<cq:include script="browsermap.jsp" />`

Exclusion de BrowserMap de certaines pages excluding-browsermap-from-certain-pages

Si vous souhaitez exclure la bibliothèque BrowserMap de certaines de vos pages où vous n’avez pas besoin de détection client, vous pouvez ajouter un attribut de requête :

<%
request.setAttribute("browsermap.enabled", false);
%>

Le script /libs/wcm/core/browsermap/browsermap.jsp ajoutera ainsi une balise meta à la page pour empêcher BrowserMap d’effectuer une détection :

<meta name="browsermap.enabled" content="false">

Test d’une version spécifique d’un site web testing-a-specific-version-of-a-web-site

En règle générale, le script BrowserMap redirige toujours les visiteurs vers la version la mieux adaptée du site web, en redirigeant généralement les visiteurs vers le bureau ou le site mobile lorsque cela est nécessaire.

Vous pouvez forcer un type d’appareil, peu importe sa requête, à tester une version particulière d’un site web en ajoutant le paramètre device à l’URL. L’URL ci-dessous diffuse la version mobile du site web Geometrixx Outdoors.

http://localhost:4502/content/geometrixx-outdoors/en.html?wcmmode=disabled&device=smartphone

NOTE

Le paramètre par défaut wcmmode est défini sur disabled afin de simuler le comportement d’une instance de publication.

La valeur remplacée est stockée dans un cookie afin que la navigation sur votre site web soit possible sans ajouter le paramètre device à chaque URL.

Par conséquent, vous devez appeler la même URL avec la valeur device définie sur browser pour revenir à la version bureau du site web.

NOTE

BrowserMap stocke la valeur device remplacée dans un cookie appelé BMAP_device. La suppression de ce cookie permet de s’assurer que CQ diffuse la version appropriée du site web en fonction de votre appareil actuel (par exemple, ordinateur de bureau ou mobile).

Traitement des demandes mobiles mobile-request-processing

AEM traite les requêtes émises par des appareils mobiles appartenant au groupe d’appareils tactiles comme suit :

Un iPad envoie une requête à l’instance de publication AEM, par ex. http://localhost:4503/content/geometrixx_mobile/en/products.html.
AEM détermine si le site de la page demandée est un site pour appareils mobiles (en vérifiant si la page de premier niveau /content/geometrixx_mobile étend le composant de page mobile). Si oui :
AEM vérifie les caractéristiques de l’appareil selon la valeur User-Agent définie dans l’en-tête de la requête.
AEM mappe les caractéristiques de l’appareil avec le groupe d’appareils et définit touch comme sélecteur de groupe d’appareils.
AEM redirige la requête vers http://localhost:4503/content/geometrixx_mobile/en/products.touch.html..
AEM envoie la réponse à l’iPad :
- La page products.touch.html est diffusée de manière habituelle et peut être mise en cache.
- Les composants de rendu utilisent des sélecteurs pour adapter la présentation.
- AEM ajoute automatiquement le sélecteur mobile à tous les liens internes de la page.

Statistiques statistics

Vous pouvez obtenir des statistiques sur le nombre de requêtes effectuées sur le serveur AEM par des appareils mobiles. Le nombre de demandes peut être ventilé :

par groupe d’appareils et appareil
par an, mois et jour

Pour visualiser les statistiques :

Accédez au Outils console.
Ouvrez le Statistiques sur les périphériques page ci-dessous Outils > Mobile.
Cliquez sur le lien pour afficher les statistiques d'une année, d'un mois ou d'un jour spécifique.

Le Statistiques page se présente comme suit :

screen_shot_2012-02-01at24353pm

NOTE

La page Statistiques est créée la première fois qu’un appareil mobile accède à AEM et est détecté. Avant cela, il n’est pas disponible.

Si vous devez générer une entrée dans les statistiques, vous pouvez procéder comme suit :

Utilisez un appareil mobile ou un émulateur (par exemple, https://chrispederick.com/work/user-agent-switcher/ sur Firefox).
Envoyez une requête pour la page mobile sur l’instance de création en désactivant le mode de création, par exemple :

http://localhost:4502/content/geometrixx_mobile/en/products.html?wcmmode=disabled

La page Statistiques est désormais disponible.

Prise en charge de la mise en cache de page pour les liens « envoyer un lien à un ami » supporting-page-caching-for-send-link-to-a-friend-links

Les pages mobiles peuvent généralement être mises en cache sur Dispatcher car les pages rendues pour un groupe d’appareils sont distinguées dans l’URL de la page par le sélecteur de groupe d’appareils, par exemple /content/mobilepage.touch.html. Une requête vers une page mobile sans sélecteur n’est jamais mise en cache puisque, dans ce cas, la détection d’appareil fonctionne et redirige au final la page vers le groupe d’appareils correspondant (ou « nomatch » plus précisément). Une page mobile générée avec un sélecteur de groupe d’appareils est traitée par le module de réécriture de liens, qui réécrit tous les liens de la page pour qu’ils contiennent également le sélecteur de groupe d’appareils, empêchant la détection de périphérique réactive pour chaque clic sur une page déjà qualifiée.

Par conséquent, vous pouvez rencontrer le scénario suivant :

L’utilisateur « Alice » est redirigé vers coolpage.feature.html et envoie cette URL à un ami « Robert » qui y accède avec un autre client appartenant au groupe d’appareils touch.

Si coolpage.feature.html est diffusée à partir d’un cache frontal, AEM ne peut pas analyser la requête pour détecter que le sélecteur mobile ne correspond pas au nouveau User-Agent, et Robert accède à un rendu inadéquat de la page.

Pour résoudre ce problème, vous pouvez inclure une interface de sélection simple sur les pages où les utilisateurs finaux peuvent remplacer le groupe d’appareils sélectionné par AEM. Dans l’exemple ci-dessus, un lien (ou une icône) sur la page permet à l’utilisateur final d’accéder à coolpage.touch.html s’il pense que cette version de la page est mieux adaptée à son appareil.

recommendation-more-help

2315f3f5-cb4a-4530-9999-30c8319c520e