Élaborer des rapports developing-reports

Ces rapports reposent sur le framework de création de rapports :

• Rapport de composants
• Rapport d’activité de la page
• Rapport de l’utilisateur
• Rapport d’instance de workflow

Les rapports suivants sont basés sur des principes individuels et ne peuvent donc pas être étendus :

• Utilisation du disque
• Contrôle de l’intégrité
• Rapport de workflow

Elle est entièrement basée sur les ensembles de résultats renvoyés par une requête exécutée par CQ5 QueryBuilder.

Le jeu de résultats définit les données affichées dans le rapport. Chaque ligne du jeu de résultats correspond à une ligne de la vue tabulaire du rapport.

Les opérations pouvant être exécutées sur le jeu de résultats ressemblent aux concepts SGBDR ; il s’agit principalement du regroupement et de l’agrégation.

La plupart des opérations de récupération et de traitement des données s’effectuent du côté serveur.

Le client ou la cliente est l’unique responsable de l’affichage des données prétraitées. Seules les tâches de traitement mineures (par exemple, la création de liens dans le contenu des cellules) sont exécutées côté client.

contient la définition de la requête qui fournit le jeu de résultats de données sous-jacent.

s’agit d’un système de paragraphes personnalisé contenant toutes les colonnes (columnbase) ajoutées au rapport.

définit les types de graphique disponibles et actuellement actifs ;

définit la boîte de dialogue Modifier, qui permet à l’utilisateur ou à l’utilisatrice de configurer certains aspects du rapport.

est définie comme faisant partie du composant reportbase ;

Est basée sur CQ QueryBuilder.

Récupère les données utilisées comme base du rapport. Chaque ligne du jeu de résultats (tableau) est liée à un nœud, tel qu’il est renvoyé par la requête. Des informations spécifiques pour les différentes colonnes sont ensuite extraites de ce jeu de données.

Se compose généralement des éléments suivants :

• Un chemin d’accès racine.

  Ce chemin spécifie la sous-arborescence du référentiel dans lequel la recherche doit être effectuée.

  Pour contribuer à réduire l’impact sur les performances, il est conseillé de limiter (dans la mesure du possible) la requête à une sous-arborescence spécifique du référentiel. Le chemin racine peut être prédéfini dans la variable modèle de rapport ou défini par l’utilisateur dans la variable Boîte de dialogue Configuration (Modifier).

• Un ou plusieurs critères.

  Ils sont imposés pour générer le jeu de résultats (initial). Il incluent, par exemple, les restrictions concernant les types de nœuds ou les contraintes de propriété.

Extraire et déduire des valeurs du jeu de résultats sous-jacent.

Cela vous permet, par exemple, de traiter deux valeurs de propriété comme s’il s’agissait d’une seule en calculant la différence entre les deux.

Résoudre les valeurs extraites : cela peut être réalisé de différentes manières.

Par exemple, des chemins d’accès peuvent être mappés sur un titre (comme dans le contenu plus lisible de la propriété jcr:title correspondante).

Application de filtres à différents points.

Création de valeurs composites, si nécessaire.

Par exemple, dans le cas d’un texte présenté à l’utilisateur, une valeur à utiliser pour le tri et une URL supplémentaire utilisée (du côté client) pour créer un lien.

propertyConstraints

Limite le jeu de résultats aux nœuds ayant des propriétés spécifiques avec des valeurs spécifiques. Si plusieurs contraintes sont spécifiées, le nœud doit toutes les respecter (opération AND).

Par exemple :

N:propertyConstraints
 [
 N:0
 P:sling:resourceType
 P:foundation/components/textimage
 N:1
 P:jcr:modifiedBy
 P:admin
 ]

Renvoie tous les composants textimage qui ont été modifiés pour la dernière fois par l’utilisateur admin.

nodeTypes

Utilisé pour limiter le jeu de résultats aux types de nœud spécifiés. Plusieurs types de nœud peuvent être spécifiés.

mandatoryProperties

Limite le jeu de résultats aux nœuds qui possèdent tous les propriétés spécifiées. La valeur des propriétés n’est pas prise en compte.

settings

Contient les définitions des graphiques actifs.

• active

  Comme plusieurs paramètres peuvent être définis, vous pouvez utiliser cette option pour définir ceux qui sont actuellement actifs. Ceux-ci sont définis par un tableau de nœuds (il n’existe pas de convention de nommage obligatoire pour ces nœuds, mais les rapports standard utilisent généralement 0, 1… x), chacun ayant la propriété suivante :

  • id

    L’identification des graphiques actifs. Elle doit correspondre à l’identification de l’une des definitions de diagramme.

definitions

Définit les types de graphiques qui peuvent être disponibles pour le rapport. Les definitions à utiliser sont spécifiées par les paramètres active.

Les définitions sont spécifiées à l’aide d’un tableau de nœuds (nommés généralement 0, 1… x), chacun ayant les propriétés suivantes :

• id

  L’identification du graphique.

• type

  Le type de graphique disponible. Faites un choix parmi les éléments suivants :

  • pie
    Graphique en secteurs. Généré uniquement à partir des données actuelles.

  • lineseries
    Série de lignes (points reliés représentant les instantanés). Généré uniquement à partir des données d’historique.

• D’autres propriétés sont disponibles, selon le type de graphique :

  • pour le type de graphique pie :

    • maxRadius (Double/Long)

      Rayon maximum autorisé pour le graphique en secteurs et donc la taille maximale autorisée pour le graphique (sans légende). Ignoré si fixedRadius est défini.

    • minRadius (Double/Long)

      Rayon minimum autorisé pour le graphique en secteurs. Ignoré si fixedRadius est défini.

    • fixedRadius (Double/Long)
      Définit un rayon fixe pour le graphique en secteurs.

  • pour le type de graphique lineseries :

    • totals (Boolean)

      True si une ligne supplémentaire affichant le Total doit être présentée.
      par défaut : false

    • series (Long)

      Nombre de lignes/séries à afficher.
      Valeur par défaut : 9 (il s’agit également du maximum autorisé)

    • hoverLimit (Long)

      Nombre maximum d'instantanés agrégés (points affichés sur chaque ligne horizontale, représentant des valeurs distinctes) pour lesquels des fenêtres contextuelles doivent être affichées. C'est-à-dire lorsque l'utilisateur ou l’utilisatrice survole avec le curseur une valeur distincte ou un libellé correspondant dans la légende du graphique.

      Valeur par défaut : 35 (en d’autres termes, aucune fenêtre contextuelle n’est affichée si plus de 35 valeurs distinctes sont applicables pour les paramètres actuels du graphique).

      Il existe une limite supplémentaire de dix fenêtres contextuelles pouvant être affichées en parallèle (plusieurs fenêtres contextuelles peuvent être affichées lorsque l’utilisateur ou l’utilisatrice survole avec le curseur le texte de la légende).

title

/libs/cq/reporting/components/commons/title

Champ de texte pour définir le titre du rapport.

description

/libs/cq/reporting/components/commons/description

Zone de texte pour définir la description du rapport.

processing

/libs/cq/reporting/components/commons/processing

Sélecteur du mode de traitement du rapport (chargement manuel/automatique des données).

scheduling

/libs/cq/reporting/components/commons/scheduling

Sélecteur de planification des instantanés pour le graphique historique.

rootPath

Limite le rapport à une certaine section (arborescence ou sous-arborescence) du référentiel, ce qui est recommandé dans le cadre de l’optimisation des performances. Le chemin d’accès racine est spécifié par la propriété rootPath du nœud report de chaque page du rapport (extrait du modèle lors de la création de la page).

Il peut être spécifié par :

• le modèle de rapport (valeur fixe ou valeur par défaut de la boîte de dialogue de configuration).
• l’utilisateur ou l’utilisatrice (à l’aide de ce paramètre)

property

Définit la propriété à utiliser pour calculer la valeur réelle de la cellule.

Si la propriété est définie en tant que chaîne[], plusieurs propriétés sont analysées (dans l’ordre) pour rechercher la valeur réelle.

Par exemple, s’il y a :

property = [ "jcr:lastModified", "jcr:created" ]

L’extracteur de valeur correspondant (qui contrôle ici) :

• vérifie si une propriété jcr:lastModified est disponible et, si tel est le cas, l’utilise.
• Si aucune propriété jcr:lastModified n’est disponible, le contenu de jcr:created est utilisé à la place.

subPath

Si le résultat ne se trouve pas sur le nœud renvoyé par la requête, subPath définit l’emplacement réel de la propriété.

secondaryProperty

Une seconde propriété à utiliser pour calculer la valeur réelle de la cellule. Cette définition n’est utilisée que pour certains types de colonnes (diff et triables).

Par exemple, dans le cas du rapport Instances de workflow, la propriété spécifiée est utilisée pour stocker la valeur actuelle du décalage horaire (en millisecondes) entre les heures de début et de fin.

secondarySubPath

Semblable à subPath, lorsque secondaryProperty est utilisé.

resolver

définit le programme de résolution à utiliser. Les programmes de résolution suivants sont disponibles :

• const

  fait correspondre des valeurs avec d’autres ; il est utilisé, par exemple, pour résoudre une constante telle que en sur sa valeur équivalente English.

• default

  Il s’agit du programme de résolution par défaut. Il s’agit d’un programme de résolution factice qui, en fait, ne résout rien.

• page

  résout une valeur de chemin sur le chemin d’accès de la page appropriée ; plus précisément, sur le nœud jcr:content correspondant. Par exemple, /content/.../page/jcr:content/par/xyz est résolu en /content/.../page/jcr:content.

• path

  Résout une valeur de chemin en ajoutant éventuellement un sous-chemin et en extrayant la valeur réelle d’une propriété du nœud (tel que défini par resolverConfig) au niveau du chemin résolu. Par exemple, un path /content/.../page/jcr:content peut être résolu sur le contenu de la propriété jcr:title ; cela signifie que le chemin de page sera résolu sur le titre de la page.

• pathextension

  résout une valeur en ajoutant un chemin d’accès en préfixe et en prenant la valeur réelle d’une propriété du nœud au niveau du chemin résolu. Par exemple, une valeur de peut être précédée d’un chemin, tel que /libs/wcm/core/resources/languages, et prendre la valeur de la propriété language pour résoudre le code de pays de sur la description de la langue German.

resolverConfig

Fournit des définitions pour le résolveur. Les options disponibles dépendent du resolver choisi :

• const

  Utilisez des propriétés pour spécifier les constantes en vue de la résolution. Le nom de la propriété définit la constante à résoudre ; la valeur de la propriété définit la valeur résolue.

  Par exemple, une propriété avec Nom=1 et Valeur =One va résoudre 1 sur One.

• default

  Aucune configuration n’est disponible.

• page

  • propertyName (facultatif)

    Définit le nom de la propriété qui doit être utilisée pour résoudre la valeur. Si elle n’est pas spécifiée, la valeur par défaut de jcr:title (titre de la page) est utilisée ; pour le programme de résolution page, cela signifie que le chemin est d’abord résolu sur le chemin d’accès de la page, puis sur le titre de la page.

• path

  • propertyName (facultatif)

    Spécifie le nom de la propriété qui doit être utilisée pour résoudre la valeur. Si elle n’est pas spécifiée, la valeur par défaut de jcr:title est utilisée.

  • subPath (facultatif)

    Cette propriété peut être utilisée pour spécifier un suffixe à ajouter au chemin d’accès avant la résolution de la valeur.

• pathextension

  • path (obligatoire)

    Définit le chemin d’accès à ajouter comme préfixe.

  • propertyName (obligatoire)

    Définit la propriété sur le chemin résolu où se situe la valeur réelle.

  • i18n (facultatif ; type booléen)

    Détermine si la valeur résolue doit être internationalisée (c’est-à-dire à l’aide des services d’internationalisation de CQ5).

preprocessing

Le prétraitement est facultatif et peut être lié (séparément) aux phases de traitement apply ou applyAfter  :

• apply

  Phase de prétraitement initiale (étape 3 dans l’organigramme de la file d’attente de traitement).

• applyAfter

  Application après le prétraitement (étape 9 dans l’organigramme de la file d’attente de traitement).

valeur d’origine :

La définition de prétraitement de la valeur d’origine est spécifiée directement sur apply et/ou applyAfter.

valeur dans son état agrégé :

Si nécessaire, une définition distincte peut être fournie pour chaque agrégation.

Pour spécifier un prétraitement explicite des valeurs agrégées, les définitions de prétraitement doivent résider sur un nœud enfant aggregated correspondant (apply/aggregated, applyAfter/aggregated). Si un prétraitement explicite est requis pour des agrégats distincts, la définition de prétraitement se trouve sur un nœud enfant ayant le nom de l’agrégat correspondant (par exemple, apply/aggregated/min/max ou d’autres agrégats).

motifs de recherche et de remplacement
Lorsqu’il est trouvé, le motif spécifié (qui est défini sous la forme d’une expression régulière) est remplacé par un autre ; il peut, par exemple, être utilisé pour extraire une sous-chaîne de l’original.

formateurs de type de données

Convertissent une valeur numérique en chaîne relative ; par exemple, la valeur `` représentant un décalage horaire de 1 heure sera résolue dans une chaîne telle que 1:24PM (1 hour ago).

pattern

Expression régulière utilisée pour localiser une sous-chaîne.

replace

Chaîne, ou représentation de la chaîne, qui sera utilisée en remplacement de la chaîne d’origine. Elle représente souvent une sous-chaîne de la chaîne localisée par l’expression régulière pattern.

Pour le nœud definitions/data/preprocessing/apply avec les deux propriétés suivantes :

• pattern: (.*)(/jcr:content)(/|$)(.*)
• replace: $1

Une chaîne qui arrive en tant que :

• /content/geometrixx/en/services/jcr:content/par/text

Divisé en quatre sections :

• $1 - (.*) - /content/geometrixx/en/services
• $2 - (/jcr:content) - /jcr:content
• $3 - (/|$) - /
• $4 - (.*) - par/text

et remplacée par la chaîne représentée par $1 :

• /content/geometrixx/en/services

format

Formateur de type de données :

• duration

  La durée correspond à l’intervalle entre deux dates définies. Par exemple, le début et la fin d’une action de workflow qui a duré 1 heure, lancée le 13/02/2011 à 11 h 23, pour se terminer une heure plus tard, le 13/02/2011 à 12 h 23.

  Il convertit une valeur numérique (interprétée en millisecondes) en chaîne de durée ; par exemple, 30000 est formaté comme * 30s.*

• datedelta

  Datadelta est une période entre une date passée et « maintenant » (le résultat sera donc différent si le rapport est visualisé ultérieurement).

  Il convertit une valeur numérique (interprétée en tant que différence temporelle en jours) en une chaîne de date relative. Par exemple, 1 est formaté comme étant « il y a 1 jour ».

type

Les options suivantes sont disponibles en standard :

• string

• number

• int

• date

• diff

• timeslot

  Utilisé pour extraire des parties d’une date nécessaires pour l’agrégation (par exemple, un regroupement par année pour obtenir des données agrégées pour chaque année).

• sortable

  Utilisé pour des valeurs qui utilisent différentes valeurs (provenant de différentes propriétés) à des fins de tri et d’affichage.

De plus, l’une des options ci-dessus peut être définie comme valeur multiple ; par exemple, string[] définit une séquence de chaînes de caractères.

L’extracteur de valeurs est sélectionné par le type de colonne. Si un extracteur de valeurs est disponible pour un type de colonne, il est utilisé. Dans le cas contraire, l’extracteur de valeur par défaut est utilisé.

Un type peut (éventuellement) prendre un paramètre. Par exemple, timeslot:year extrait l’année d’un champ de date. Types avec leurs paramètres :

• timeslot - Les valeurs sont comparables aux constantes correspondantes de java.utils.Calendar.

  • timeslot:year - Calendar.YEAR
  • timeslot:month-of-year - Calendar.MONTH
  • timeslot:week-of-year - Calendar.WEEK_OF_YEAR
  • timeslot:day-of-month - Calendar.DAY_OF_MONTH
  • timeslot:day-of-week - Calendar.DAY_OF_WEEK
  • timeslot:day-of-year - Calendar.DAY_OF_YEAR
  • timeslot:hour-of-day - Calendar.HOUR_OF_DAY
  • timeslot:minute-of-hour - Calendar.MINUTE

groupable

Détermine si le rapport peut être regroupé en fonction de cette colonne.

filters

Définitions de filtre.

• filterType

  Les filtres disponibles sont les suivants :

  • string

    Un filtre basé sur une chaîne.

• id

  Identifiant du filtre.

• phase

  Phases disponibles :

  • raw

    Le filtre est appliqué sur les données brutes.

  • preprocessed

    Le filtre est appliqué sur les données prétraitées.

  • resolved

    Le filtre est appliqué sur les données résolues.

aggregates

Définitions d’agrégat.

• text

  Nom textuel de l’agrégat. Si text n’est pas spécifié, alors il prend la description par défaut de l’agrégat. Par exemple, minimum est utilisé pour l’agrégat min.

• type

  Type d’agrégat. Les agrégats disponibles sont les suivants :

  • count

    Compte le nombre de lignes.

  • count-nonempty

    Compte le nombre de lignes non vides.

  • min

    Fournit la valeur minimale.

  • max

    Fournit la valeur maximale.

  • average

    Fournit la valeur moyenne.

  • sum

    Fournit la somme de toutes les valeurs.

  • median

    Fournit la valeur médiane.

  • percentile95

    Utilise le 95e percentile de toutes les valeurs.

aggregate

Les valeurs aggregate valides sont les mêmes que pour type sous aggregates (voir Définitions spécifiques à la colonne (définitions - filtres / agrégats)).

Définissez la propriété type du nœud definition de la colonne sur generic.

Consultez /libs/cq/reporting/components/userreport/genericcol/definitions.

Spécifiez une définition de boîte de dialogue (standard) sous le nœud definition de la colonne.

Consultez /libs/cq/reporting/components/userreport/genericcol/definitions/dialog.

• Les champs de la boîte de dialogue doivent faire référence aux mêmes noms que la propriété de composant correspondante (y compris son chemin d’accès).

  Par exemple, si vous souhaitez que le type de la colonne générique puisse être configuré par le biais de la boîte de dialogue, utilisez un champ avec le nom ./definitions/type.

• Les propriétés définies à l’aide de l’interface utilisateur/la boîte de dialogue sont prioritaires sur celles définies sur le composant columnbase.

Définissez la configuration de modification.

Consultez /libs/cq/reporting/components/userreport/genericcol/cq:editConfig.

Utilisez les méthodes AEM standard pour définir des propriétés de colonne (supplémentaires).

Pour les propriétés qui sont définies à la fois sur les instances de composant et de colonne, la valeur définie sur la colonne est prioritaire.

Les propriétés disponibles pour une colonne générique sont les suivantes :

• jcr:title - Nom de la colonne
• definitions/aggregates - Agrégats
• definitions/filters - Filtres
• definitions/type - Type de la colonne (doit être défini dans la boîte de dialogue, soit à l’aide d’un sélecteur ou d’une zone de liste modifiable, soit d’un champ masqué)
• definitions/data/resolver et definitions/data/resolverConfig (mais pas definitions/data/preprocessing ou .../clientFilter) - Le programme de résolution et la configuration
• definitions/queryBuilder - Configuration du générateur de requêtes
• defaults/aggregate - Agrégat par défaut

Dans le cas d’une nouvelle instance de la colonne générique dans le Rapport utilisateur, les propriétés définies avec la boîte de dialogue sont conservées sous :

/etc/reports/userreport/jcr:content/report/columns/genericcol/settings/generic

/etc/designs/reports/<yourReport> convient si le rapport se trouve sous /apps/cq/reporting.

/etc/designs/<yourProject>/reports/<*yourReport*> pour les rapports utilisant le motif /apps/<yourProject>/reports.

components

Tous les composants et/ou groupes de composants autorisés sur le rapport.

sling:resourceType

Propriété avec la valeur cq/reporting/components/repparsys.

définir le sling:resourceType sur cq/reporting/components/reportpage ;

indiquer la conception à utiliser ;

créer un nœud enfant report qui référence le composant de conteneur (reportbase) au moyen de la propriété sling:resourceType.

Fuseau horaire définit le fuseau horaire pour lequel les données historiques sont créées. Cela permet de s’assurer que le graphique historique affiche les mêmes données pour chaque utilisateur ou utilisatrice dans le monde entier.

L’option Paramètres régionaux définit les paramètres régionaux à utiliser conjointement avec le Fuseau horaire pour les données historiques. Le paramètre régional permet de déterminer certains paramètres du calendrier spécifiques à un paramètre régional (par exemple, si le premier jour de la semaine est un dimanche ou un lundi).

Chemin de l’instantané définit le chemin racine où sont stockés les instantanés des graphiques historiques.

Chemin d’accès aux rapports définit le chemin d’accès à l’emplacement des rapports. Cela est utilisé par le service d’instantanés pour déterminer les rapports pour lesquels des instantanés doivent être créés.

Instantanés quotidiens définit l’heure de chaque jour à laquelle des instantanés quotidiens sont réalisés. L’heure spécifiée se trouve dans le fuseau horaire local du serveur.

Instantanés horaires définit la minute de chaque heure à laquelle des instantanés horaires sont réalisés.

Lignes (max) définit le nombre maximal de lignes stockées pour chaque instantané. Cette valeur doit être choisie raisonnablement. Si elle est trop élevée, cela a une incidence sur la taille du référentiel. Si elle est trop basse, les données peuvent ne pas être exactes en raison de la manière dont les données historiques sont traitées.

Fausses données  : si cette option est activée, de fausses données historiques peuvent être créées à l’aide du sélecteur fakedata. Si elle est désactivée, l’utilisation du sélecteur fakedata générera une exception.

Les données étant fausses, elles doivent uniquement être utilisées à des fins de test et de débogage.

En utilisant fakedata, le sélecteur termine le rapport implicitement, donc toutes les données existantes sont perdues. Les données peuvent être restaurées manuellement, mais cela peut prendre du temps.

Utilisateur d’instantanés  : définit un utilisateur facultatif qui peut être utilisé pour prendre des instantanés.

En fait, les instantanés sont réalisés pour l’utilisateur qui a terminé le rapport. Dans certains cas (par exemple, sur un système de publication, où cet utilisateur ou cette utilisatrice n’existe pas, car son compte n’a pas été répliqué), vous pouvez spécifier une personne de secours qui est utilisée à la place.

Spécifier un utilisateur ou une utilisatrice peut, en outre, poser un risque sur le plan de la sécurité.

Imposer l’utilisateur ou l’utilisatrice d’instantanés  : si cette option est activée, tous les instantanés sont effectués avec la personne spécifiée sous Utilisateur ou utilisatrice d’instantanés. Mal gérée, cette option peut présenter de sérieux risques sur la sécurité.