Création de rapports reporting
Pour vous aider à analyser et surveiller l’état de votre instance, AEM propose une sélection de rapports par défaut, qui peuvent être configurés en fonction de vos besoins :
Tous ces rapports sont accessibles à partir de la console Outils. Sélectionnez Rapports dans le volet de gauche, puis double-cliquez sur le rapport dans le volet de droite pour l’ouvrir afin de l’afficher et de le configurer.
De nouvelles instances d’un rapport peuvent également être créées à partir de la console Outils. Sélectionnez Rapports dans le panneau de gauche, puis Nouveau dans la barre d’outils. Définissez un Titre et un Nom, sélectionnez le type de rapport dont vous avez besoin, puis cliquez sur Créez. Votre nouvelle instance de rapport apparaît dans la liste. Double-cliquez pour l’ouvrir, puis faites glisser un composant du sidekick pour créer la première colonne et commencer la définition du rapport.
Principes de base de la personnalisation des rapports the-basics-of-report-customization
Divers formats de rapport sont disponibles. Les rapports suivants utilisent tous des colonnes qui peuvent être personnalisées comme indiqué dans les sections suivantes :
- Le rapport Contrôle de l’intégrité utilise des champs de sélection pour spécifier les données sur lesquelles vous souhaitez générer des rapports.
- Utilisation du disque utilise des liens pour parcourir la structure du référentiel.
- Rapport Workflow donne un aperçu des workflows exécutés sur votre instance.
Sélection et positionnement des colonnes de données selecting-and-positioning-the-data-columns
Vous pouvez ajouter, repositionner ou supprimer des colonnes de n’importe quel rapport, standard ou personnalisé.
Le Composants l’onglet du sidekick (disponible sur la page du rapport) répertorie toutes les catégories de données qui peuvent être sélectionnées en tant que colonnes.
Pour modifier la sélection des données :
-
Pour ajouter une nouvelle colonne, faites glisser le composant requis à partir du sidekick et déposez-le dans la position souhaitée.
- une coche verte indique quand la position est valide et une paire de flèches indique exactement où elle sera placée.
- un symbole rouge indiquant quand la position n’est pas valide
-
pour déplacer une colonne, cliquez sur l’en-tête, maintenez la touche enfoncée et faites-la glisser vers la nouvelle position.
-
pour supprimer une colonne, cliquez sur le titre de la colonne, maintenez la souris enfoncée et faites-la glisser dans la zone d’en-tête du rapport (un signe moins rouge indique que la position n’est pas valide). relâchez le bouton de la souris et la boîte de dialogue Supprimer le(s) composant(s) vous demandera de confirmer que vous souhaitez vraiment supprimer la colonne.
Menu déroulant Colonne column-drop-down-menu
Chaque colonne du rapport comprend un menu déroulant. Ce menu apparaît lorsque le curseur de la souris se trouve au-dessus de la cellule du titre de colonne.
Une flèche s’affiche à l’extrémité droite de la cellule du titre (à ne pas confondre avec la flèche située immédiatement à droite du texte de titre et qui indique le mécanisme de tri actuel).
Les options disponibles dans le menu dépendent de la configuration de la colonne (telle que définie lors du développement de projet), et toutes les options non valides sont grisées.
Tri des données sorting-the-data
Les données peuvent être triées selon une colonne spécifique en :
- Cliquez sur l’en-tête de colonne voulu. Le tri bascule entre ordre croissant et décroissant, indiqué par une flèche immédiatement à côté du texte de titre.
- utilisez la méthode menu déroulant de la colonne pour sélectionner spécifiquement l’une des Tri croissant ou Tri décroissant; une fois de plus, une flèche située juste à côté du texte du titre indique que
Groupes et graphique des données actives groups-and-the-current-data-chart
Sur les colonnes appropriées, vous pouvez sélectionner Groupe par cette colonne dans le menu déroulant de la colonne. Ceci a pour effet de regrouper les données selon chaque valeur distincte dans cette colonne. Vous pouvez sélectionner plusieurs colonnes à regrouper. Cette option est grisée lorsque les données de la colonne ne sont pas appropriées : chaque entrée est distincte et unique et aucun groupe ne peut donc être formé. Par exemple, la colonne ID de l’utilisateur du rapport d’utilisateur.
Lorsqu’au moins une colonne a été groupée, un diagramme circulaire des Données actuelles est généré en fonction de ce regroupement. Si plusieurs colonnes sont regroupées, ceci est également indiqué sur le diagramme.
Placez le pointeur de la souris au-dessus du diagramme circulaire pour afficher la valeur agrégée du segment approprié. Cette méthode utilise l’agrégat actuellement défini dans la colonne ; par exemple, nombre, minimum, moyenne, entre autres.
Filtres et agrégats filters-and-aggregates
Sur les colonnes appropriées, vous pouvez également configurer Paramètres de filtre et/ou Agrégats de la menu déroulant de la colonne.
Filtres filters
Les paramètres de filtre vous permettent de spécifier les critères des entrées à afficher. Les opérateurs disponibles sont les suivants :
containsequals
Pour définir un filtre :
- Sélectionnez l’opérateur de votre choix dans la liste déroulante.
- Saisissez le texte à filtrer.
- Cliquez sur Appliquer.
Pour désactiver le filtre :
- Supprimez le texte du filtre.
- Cliquez sur Appliquer.
Agrégats aggregates
Vous pouvez également sélectionner une méthode d’agrégation (elle peut varier en fonction de la colonne sélectionnée) :
Propriétés de colonne column-properties
Cette option est uniquement disponible lorsque la Colonne générique a été utilisée dans le Rapport de l’utilisateur.
Données d'historique historic-data
Un graphique des changements survenant dans vos données au fil du temps est visible dans les Données historiques. Il est dérivé des instantanés réalisés à intervalles réguliers.
Les données sont les suivantes :
- Collecté par, si disponible, la première colonne triée, sinon la première colonne (non regroupée)
- Regroupés par la colonne appropriée
Le rapport peut être généré :
-
Définir Regroupement sur la colonne requise.
-
Modifier la configuration pour définir la fréquence à laquelle les instantanés doivent être créés ; horaire ou quotidien.
-
Terminer… la définition pour lancer la collecte des instantanés.
Le bouton curseur rouge/vert situé en haut à gauche indique à quel moment les instantanés sont collectés.
Le graphique qui en résulte est affiché en bas à droite :
Une fois la collecte de données commencée, vous pouvez sélectionner les options suivantes :
-
Période
Vous pouvez sélectionner les dates de début et de fin pour les données de rapport à afficher.
-
Intervalle
Vous pouvez sélectionner Mois, Semaine, Jour et Heure pour l’échelle et l’agrégation du rapport.
Par exemple, si des instantanés quotidiens sont disponibles pour le mois de février 2011 :
- Si l’intervalle est défini sur
Day, chaque instantané s’affiche comme une valeur unique dans le graphique. - Si l’intervalle est défini sur
Month, tous les instantanés de février sont regroupés en une seule valeur (affichée sous la forme d’un « point » unique dans le graphique).
- Si l’intervalle est défini sur
Faites vos choix selon vos besoins, puis cliquez sur Aller pour les appliquer au rapport. Pour mettre à jour l’affichage après la création d’autres instantanés, cliquez de nouveau sur OK.
Lorsque des instantanés sont collectés, vous pouvez :
-
Utilisation Terminer… pour réinitialiser la collection.
Terminer « gèle » la structure du rapport (à savoir, les colonnes affectées au rapport et groupées, triées, filtrées, etc.) et commence à créer des instantanés.
-
Ouvrez le Modifier boîte de dialogue de sélection Aucun instantané de données pour mettre fin à la collection jusqu’à ce que nécessaire.
Modifier active ou désactive uniquement la création des instantanés. Si la création d’instantanés est réactivée, elle utilise le statut du rapport lorsque celui-ci a été la terminé la dernière fois pour créer d’autres instantanés.
/var/reports/..., le reste du chemin d’accès reflétant le chemin d’accès du rapport et de l’ID créés lorsque le rapport a été terminé.Daily snapshots (repconf.hourofday) de la Configuration du reporting Day CQ. Consultez la Configuration d’OSGI pour plus d’informations sur cette configuration.Limites d’affichage display-limits
Le rapport des données historiques peut également légèrement changer d’aspect en raison des limites qui peuvent être définies, en fonction du nombre de résultats pour la période sélectionnée.
Chaque ligne horizontale est une série (et correspond à une entrée dans la légende du graphique), et chaque colonne verticale de points représente les instantanés agrégés.
Pour que le graphique reste propre sur des périodes plus longues, vous pouvez définir des limites. Pour les rapports standard, ces éléments sont les suivants :
-
série horizontale - La valeur maximale par défaut comme la valeur système sont
9. -
instantanés agrégés verticaux - La valeur par défaut est
35(par série horizontale).
Ainsi, lorsque les limites (appropriées) sont dépassées :
- les points ne s’affichent pas.
- la légende du graphique de données historique peut afficher un nombre d’entrées différent de celui du graphique de données actuel.
Les rapports personnalisés peuvent également afficher la valeur Total pour toutes les séries. Ceci est illustré sous la forme d’une série (ligne horizontale et entrée dans la légende).
Modifier (rapport) edit-report
Le Modifier ouvre le bouton Modifier le rapport Boîte de dialogue.
Il s’agit d’un emplacement où la période de collecte des instantanés pour les Données historiques est définie, mais d’autres paramètres peuvent également être définis :
-
Titre
Vous pouvez définir votre propre titre.
-
Description
Vous pouvez définir votre propre description.
-
Chemin racine (actif uniquement pour certains rapports)
Utilisez cette option pour limiter le rapport à une sous-section du référentiel.
-
Traitement du rapport
-
données automatiquement actualisées
Les données du rapport sont actualisées chaque fois que vous mettez la définition du rapport à jour.
-
données actualisées manuellement
Cette option peut être utilisée pour éviter les retards causés par des opérations d’actualisation automatique en cas de volume de données élevé.
Cette option indique que les données du rapport doivent être actualisées manuellement lorsqu’un aspect de la configuration du rapport a changé. Cela signifie également que dès que vous changez un aspect de la configuration du rapport, le tableau est effacé.
Lorsque cette option est sélectionnée, le bouton Charger les données s’affiche (en regard de Modifier sur le rapport). Le bouton Charger les données charge les données et actualise les données du rapport affichées.
-
-
Instantanés
Vous pouvez définir la fréquence pour créer des instantanés : quotidienne, horaire ou pas du tout.
Charger les données load-data
Le bouton Charger les données est uniquement visible lorsque l’option données actualisées manuellement a été sélectionnée dans Modifier.
Un clic sur le bouton Charger les données a pour effet de recharger les données et de mettre le rapport affiché à jour.
Choisir d’actualiser manuellement les données signifie que :
-
dès que vous changez la configuration du rapport, la table des données du rapport est effacée.
Par exemple, si vous modifiez le mécanisme de tri d’une colonne, les données ne sont pas affichées.
-
Si vous souhaitez que les données du rapport s’affichent à nouveau, vous devez cliquer sur Chargement de données pour recharger les données.
Terminer (rapport) finish-report
Lorsque vous Terminer le rapport :
- La définition de rapport à partir de ce moment est utilisée pour créer les instantanés (vous pouvez ensuite continuer à travailler sur une définition de rapport, car elle est alors séparée des instantanés).
- Tous les instantanés existants seront supprimés.
- De nouveaux instantanés sont collectés pour la variable Données historiques.
Avec cette boîte de dialogue, vous pouvez définir ou mettre à jour votre propre titre et votre propre description du rapport.
Types de rapports report-types
Rapport de composants component-report
Le rapport de composants fournit des informations sur la façon dont votre site web utilise les composants.
Les colonnes d’informations sur les éléments suivants :
- Création
- Chemin de composant
- Type de composant
- Date de dernière modification
- Page
Signifie que vous pouvez voir, par exemple :
-
Quels composants sont utilisés où.
Utile, par exemple, lors des tests.
-
La manière dont les instances d’un composant sont distribuées.
Ceci peut être intéressant si certaines pages (des « pages lourdes ») rencontrent des problèmes de performances.
-
Identifiez les parties du site avec des modifications fréquentes/moins fréquentes.
-
Découvrez comment le contenu des pages se développe au fil du temps.
Tous les composants sont inclus, ceux standard produit comme ceux spécifiques aux projets. Avec la boîte de dialogue Modifier, l’utilisateur peut également définir un Chemin racine qui définit le point de départ du rapport. Tous les composants sous cette racine sont pris en compte pour le rapport.
Utilisation du disque disk-usage
Le rapport d’utilisation du disque affiche des informations sur les données stockées dans votre référentiel.
Le rapport commence à la racine (/) du référentiel. En cliquant sur une branche, vous pouvez explorer le référentiel (le chemin d’accès actuel est reflété dans le titre du rapport).
Contrôle de l’intégrité health-check
Ce rapport analyse le journal des requêtes en cours :
<cq-installation-dir>/crx-quickstart/logs/request.log
pour vous aider à identifier la ou les demandes les plus coûteuses au cours d’une période donnée.
Pour générer le rapport, vous pouvez spécifier les éléments suivants :
-
Période (heures)
Nombre d’heures (passées) pour l’analyse.
Valeur par défaut :
24 -
Résultats maximum
Nombre maximal de lignes de sortie.
Valeur par défaut :
50 -
Requêtes maximum
Nombre maximal de demandes à analyser.
Valeur par défaut :
-1(tout) -
Adresse électronique
Envoyez les résultats à une adresse électronique.
Facultatif ; valeur par défaut : non renseigné
-
Exécuter quotidiennement à (hh:mm) :
Spécifiez l’heure à laquelle le rapport doit être exécuté automatiquement tous les jours.
Facultatif ; valeur par défaut : non renseigné
Rapport d’activité de la page page-activity-report
Le rapport d’activité de la page répertorie les pages et les actions effectuées sur celles-ci.
Les colonnes d’informations sur les éléments suivants :
- Page
- Temps
- Type
- Utilisateur
Vous pouvez contrôler les éléments suivants :
- Les dernières modifications.
- Auteurs travaillant sur des pages spécifiques.
- Les pages qui n’ont pas été modifiées récemment peuvent donc nécessiter une action.
- Pages les plus/moins fréquemment modifiées.
- La plupart/le moins principal des utilisateurs.
Le rapport d’activité de la page récupère toutes ses informations dans le journal d’audit. Par défaut, le chemin d’accès racine est configuré sur le journal d’audit dans /var/audit/com.day.cq.wcm.core.page.
Rapport de contenu généré par l’utilisateur user-generated-content-report
Ce rapport fournit des informations sur le contenu généré par l’utilisateur, qu’il s’agisse de commentaires, d’évaluations ou de forums.
Colonnes d’informations sur :
- Date
- Adresse IP
- Page
- Référent
- Type
- Utilisateur Identifiant
Permet d’effectuer les opérations suivantes :
- déterminer les pages qui reçoivent le plus de commentaires ;
- Obtenez un aperçu de l’ensemble des commentaires que des visiteurs du site laissent, avec éventuellement les problèmes associés.
- Évaluez si le nouveau contenu suscite des commentaires en surveillant les commentaires laissés sur une page.
Rapport de l’utilisateur user-report
Ce rapport fournit des informations sur tous les utilisateurs qui ont enregistré un compte ou un profil. Ceci peut comprendre les auteurs de votre organisation et les visiteurs externes.
Colonnes d’informations (le cas échéant) à propos de :
- Age
- Pays
- Domaine
- Courrier électronique
- Nom de famille
- Sexe
- Générique
- Prénom
- Infos
- Intérêt
- Langue
- Hasch Code NTLM
- ID de l'utilisateur
Permet d’effectuer les opérations suivantes :
- Voir la répartition démographique de vos utilisateurs.
- Créer un rapport sur les champs personnalisés que vous avez ajoutés aux profils.
Colonne générique generic-column
Le Générique est disponible dans le rapport d’utilisateur afin que vous puissiez accéder à des informations personnalisées, généralement à partir de la variable profils utilisateur; par exemple, Couleur préférée comme décrit dans la section Ajout de champs à la définition de profil.
La boîte de dialogue Colonne générique s’ouvre lorsque vous :
- Faites glisser le composant Générique du sidekick vers le rapport.
- Sélectionnez Propriétés de colonne pour une colonne Générique existante.
Dans l’onglet Définitions, vous pouvez définir :
-
Titre
Votre propre titre pour la colonne générique.
-
Propriété
Le nom de propriété tel que stocké dans le référentiel, généralement dans le profil de l’utilisateur.
-
Chemin
Cette propriété est généralement extraite du
profile. -
Type
Sélectionnez le type de champ entre
String,Number,Integer,Date. -
Agrégat par défaut
Ce champ définit l’agrégat utilisé par défaut si la colonne est dissociée dans un rapport ayant au moins une colonne groupée. Sélectionnez l’agrégat requis entre
Count,Minimum,Average,Maximum,Sum.Par exemple, Nombre pour un champ
Stringsignifie que le nombre de valeursStringdistinctes est affiché pour la colonne en statut agrégé.
Dans l’onglet Étendu, vous pouvez également définir les agrégats et les filtres disponibles :
Rapport d’instance de workflow workflow-instance-report
Vous obtenez ainsi une vue d’ensemble concise, fournissant des informations sur les instances individuelles des workflows, en cours d’exécution et terminés.
Les colonnes d’informations sur les éléments suivants :
- Terminé
- Durée
- Initiateur
- Modèle
- Payload
- Démarré
- Statut
Vous pouvez ainsi :
- Surveiller la durée moyenne des workflows ; si cela se produit régulièrement, cela peut mettre en évidence des problèmes avec le workflow.
Rapport de workflow workflow-report
Ce rapport fournit des statistiques clés sur les workflows s’exécutant sur votre instance.
Utilisation de rapports dans un environnement de publication using-reports-in-a-publish-environment
Une fois que vous avez configuré les rapports selon vos besoins, vous pouvez les activer pour charger la configuration vers l’environnement de publication.
Le rapport approprié sera alors accessible sous
/etc/reports
Par exemple, le rapport de contenu généré par l’utilisateur figure sous :
http://localhost:4503/etc/reports/ugcreport.html
Il rend à présent compte des données collectées dans l’environnement de publication.
Puisqu’aucune configuration de rapport n’est autorisée dans l’environnement de publication, les boutons Modifier et Terminer ne sont pas disponibles. Toutefois, vous pouvez sélectionner la Période et l’Intervalle des rapports de Données historiques si des instantanés sont collectés.
/etc/reports ne soit pas accessible aux visiteurs externes. Consultez la Liste de contrôle de sécurité pour plus de détails.Autorisations nécessaires pour l’exécution des rapports permissions-needed-for-running-reports
Les autorisations nécessaires dépendent de l’action :
- Les données des rapports sont essentiellement collectées à l’aide des privilèges de l’utilisateur actuel.
- Les données historiques sont collectées à l’aide des privilèges de l’utilisateur qui a terminé le rapport.
Dans une installation AEM standard, les autorisations suivantes sont prédéfinies pour les rapports :
-
Rapport de l’utilisateur
user administrators- Lecture et écriture -
Rapport d’activité de la page
contributors- lecture et écriture -
Rapport de composants
contributors- Lecture et écriture -
Rapport de contenu généré par l’utilisateur
contributors- Lecture et écriture -
Rapport d’instance de workflow
workflow-users- Lecture et écriture
Tous les membres du groupe administrators disposent des droits nécessaires pour créer de nouveaux rapports.