Personnalisation et extensions de fragments de contenu

Dans Adobe Experience Manager as a Cloud Service, un fragment de contenu étend une ressource standard ; voir :

Architecture

Les éléments de base d’un fragment de contenu sont les suivants :

  • un fragment de contenu,
  • comportant un ou plusieurs éléments de contenu,
  • et qui peut avoir une ou plusieurs variations de contenu.

Les fragments de contenu individuels sont basés sur des modèles de fragment de contenu :

  • Les modèles de fragment de contenu définissent la structure d’un fragment de contenu lors de sa création.

  • Un fragment référençant le modèle, les modifications du modèle peuvent impacter tous les fragments dépendants.

  • Les modèles sont composés de types de données.

  • Les fonctions pour ajouter des variations, etc., doivent mettre à jour le fragment en conséquence.

    REMARQUE

    Pour que vous puissiez afficher/restituer un fragment de contenu, votre compte doit disposer d’autorisations de lecture (read) pour le modèle.

    ATTENTION

    Toutes les modifications apportées à un modèle de fragment de contenu existant peuvent impacter les fragments dépendants, ce qui peut engendrer des propriétés orphelines dans ces fragments.

Intégration de Sites à Assets

La gestion des fragments de contenu (CFM) fait partie d’AEM Assets en tant que :

  • Les fragments de contenu sont des ressources.
  • Ils utilisent la fonctionnalité Assets existante.
  • Ils sont entièrement intégrés à Assets (consoles d’administration, etc.).

Les fragments de contenu sont considérés comme une fonctionnalité de Sites pour les raisons suivantes :

  • Ils sont utilisés lors de la création de vos pages.

Mappage des fragments de contenu à Assets

fragment de contenu mappé à des ressources

Les fragments de contenu, basés sur un modèle de fragment de contenu, sont mappés à une ressource unique :

  • L’ensemble du contenu est stocké sous le nœud jcr:content/data de la ressource :

    • Les données d’éléments sont stockées sous le sous-nœud maître :

      jcr:content/data/master

    • Les variations sont stockées sous un sous-nœud portant le nom de la variation :
      par exemple, jcr:content/data/myvariation.

    • Les données de chaque élément sont stockées dans le sous-nœud respectif en tant que propriété avec le nom d’élément :
      par exemple, le contenu de l’élément text est stocké en tant que propriété text sur jcr:content/data/master.

  • Les métadonnées et le contenu associé sont stockés sous jcr:content/metadata
    Hormis le titre et la description, qui ne sont pas considérés comme des métadonnées traditionnelles et sont stockés sur jcr:content.

Emplacement des ressources

Comme pour les ressources standard, un fragment de contenu est conservé sous :

/content/dam

Autorisations de ressources

Pour plus d’informations, voir Fragments de contenu – considérations sur la suppression.

Intégration de fonction

Pour une intégration au composant de base Assets :

  • La fonction de gestion des fragments de contenu (CFM) s’appuie sur le composant de base Assets.

  • CFM possède ses propres mises en œuvre pour les éléments dans les vues Carte/Colonnes/Liste. Celles-ci se connectent aux mises en œuvre de rendu de contenu existantes d’Assets.

  • Plusieurs composants d’Assets ont été étendus pour prendre en charge les fragments de contenu.

Utilisation des fragments de contenu dans les pages

ATTENTION

Les fragments de contenu peuvent être référencés à partir des pages d’AEM, comme tout autre type de ressource. AEM fournit la variable Composant principal Fragment de contenu - a qui permet d’inclure des fragments de contenu sur vos pages. Vous pouvez également étendre ce composant de base de fragment de contenu.

  • Le composant utilise la propriété fragmentPath pour référencer le fragment de contenu. La propriété fragmentPath est traitée de la même façon que les propriétés similaires d’autres types de ressources, par exemple, lorsque le fragment de contenu est déplacé vers un autre emplacement.

  • Le composant permet de sélectionner la variation à afficher.

  • En outre, une plage de paragraphes peut être sélectionnée pour limiter la sortie ; par exemple, elle peut être utilisée pour la sortie à plusieurs colonnes.

  • Le composant accepte le contenu intermédiaire :

    • Ici, le composant vous permet de placer d’autres ressources (images, etc.) entre les paragraphes du fragment référencé.

    • Pour le contenu intermédiaire, vous devez :

      • être conscient du risque de références instables ; le contenu intermédiaire (ajouté lors de la création d’une page) n’a pas de rapport fixe avec le paragraphe adjacent, et l’insertion d’un nouveau paragraphe (dans l’éditeur de fragments de contenu) avant la position du contenu intermédiaire peut entraîner la perte de l’emplacement relatif ;

      • prendre en compte les paramètres supplémentaires (tels que les filtres de variation et de paragraphe) pour configurer ce qui est rendu sur la page.

REMARQUE

Modèle de fragment de contenu :

Lorsqu’un fragment de contenu est utilisé sur une page, le modèle de fragment de contenu sur lequel il est basé est référencé.

Cela signifie que si le modèle n’a pas été publié au moment de la publication de la page, il est marqué et le modèle est ajouté aux ressources à publier avec la page.

Intégration à d’autres structures

Les fragments de contenu peuvent être intégrés avec :

  • Des traductions

    Les fragments de contenu sont entièrement intégrés au workflow de traduction AEM. Sur le plan architectural, cela signifie :

    • Les traductions individuelles d’un fragment de contenu sont en fait des fragments distincts, par exemple :

      • elles sont situées sous des racines de langue différentes, mais partagent exactement le même chemin relatif sous la racine de langue appropriée :

        /content/dam/<path>/en/<to>/<fragment>

        ou

        /content/dam/<path>/de/<to>/<fragment>

    • Outre les chemins basés sur des règles, il n’existe aucune connexion entre les différentes versions linguistiques d’un fragment de contenu ; elles sont traitées comme deux fragments distincts, bien que l’IU fournisse les moyens de naviguer entre les variantes de langues.

    REMARQUE

    Le workflow de traduction AEM fonctionne avec /content :

    • Les modèles de fragment de contenu résidant dans /conf ; ils ne sont pas inclus dans ces traductions. Vous pouvez internationaliser les chaînes de l’IU.

  • Des schémas de métadonnées

    • Les fragments de contenu (re-utiliser) schémas de métadonnées, qui peut être défini avec des ressources standard.

    • CFM fournit son propre schéma spécifique :

      /libs/dam/content/schemaeditors/forms/contentfragment

      il peut être étendu si nécessaire.

    • Le formulaire de schéma respectif est intégré à l’éditeur de fragments.

API de gestion des fragments de contenu – côté serveur

Vous pouvez utiliser l’API côté serveur pour accéder à vos fragments de contenu ; voir :

com.adobe.cq.dam.cfm

ATTENTION

Il est vivement recommandé d’utiliser l’API côté serveur au lieu d’accéder directement à la structure de contenu.

Interfaces principales

Les trois interfaces suivantes peuvent faire office de points d’entrée :

  • Fragment de contenu (ContentFragment)

    Cette interface vous permet d’utiliser un fragment de contenu de manière abstraite.

    L’interface permet les actions suivantes :

    • Gestion des informations de base (par exemple, obtenir le nom ou obtenir/définir le titre/la description)

    • Accès aux métadonnées

    • Accès aux éléments :

      • Eléments de liste

      • Obtention des éléments par nom

      • Création des éléments (voir Restrictions)

      • Accès aux données des éléments (voir ContentElement)

    • Variations de liste définies pour le fragment

    • Création de variations globalement

    • Gérer le contenu associé :

      • Lister des collections
      • Ajout de collections
      • Suppression de collections

    • Accès au modèle du fragment

    Les interfaces qui représentent les éléments principaux d’un fragment sont les suivantes :

    • Élément de contenu (ContentElement)

      • Obtention des informations de base (nom, titre et description)

      • Obtenir/définir du contenu

      • Accéder aux variantes d’un élément :

        • Variations de liste
        • Obtention de variations par nom
        • Création de variations (voir Avertissements)
        • Suppression de variations (voir Restrictions)
        • Accès aux données de variation (voir ContentVariation)

      • Raccourci pour résoudre les variations (application d’une logique de secours supplémentaire spécifique à l’implémentation si la variation spécifiée n’est pas disponible pour un élément)

    • Variation de contenu (ContentVariation)

      • Obtention des informations de base (nom, titre et description)
      • Obtenir/définir du contenu
      • Synchronisation simple, basée sur les informations de dernière modification

    Chacune des trois interfaces (ContentFragment, ContentElement et ContentVariation) étend l’interface Versionable, ce qui ajoute des fonctionnalités de contrôle de version, requises pour les fragments de contenu :

    • Création d’une version de l’élément
    • Liste des versions de l’élément
    • Obtention du contenu d’une version spécifique de l’élément versionné

Adaptation – utilisation d’adaptTo()

Ce qui suit peut être adapté :

  • ContentFragment peut être adapté en :

    • Resource – ressource Sling sous-jacente ; la mise à jour directe de la Resource sous-jacente nécessite la reconstruction de l’objet ContentFragment.

    • Asset – abstraction Asset DAM représentant le fragment de contenu ; la mise à jour directe de la Asset sous-jacente nécessite la reconstruction de l’objet ContentFragment.

  • ContentElement peut être adapté en :

    • ElementTemplate pour accéder aux informations structurelles de l’élément.

  • FragmentTemplate

  • Resource peut être adapté en :

    • ContentFragment

Restrictions

Il convient de noter les éléments suivants :

  • L’API entière est conçue pour not conserver les modifications automatiquement (sauf indication contraire dans l’API JavaDoc) ; Vous devrez donc toujours valider le résolveur de ressources de la requête correspondante (ou le résolveur que vous utilisez réellement).

  • Tâches pouvant nécessiter un effort supplémentaire :

    • Il est fortement recommandé de créer des variations à partir de ContentFragment. Cela permet de s’assurer que tous les éléments partagent cette variation et que les structures de données globales appropriées sont mises à jour si nécessaire afin de refléter la variation nouvellement créée dans la structure de contenu.

    • La suppression de variations existantes par l’intermédiaire d’un élément, à l’aide de ContentElement.removeVariation(), ne mettra pas à jour les structures de données globales affectées à la variation. Pour garantir le maintien de la synchronisation de ces structures, utilisez plutôt ContentFragment.removeVariation(), ce qui supprime globalement une variation.

API de gestion des fragments de contenu – côté client

ATTENTION

L’API côté client est interne.

Informations supplémentaires

Reportez-vous aux informations suivantes :

  • filter.xml

    Le fichier filter.xml pour la gestion des fragments de contenu est configuré pour ne pas chevaucher le package de contenu de base d’Assets.

Sessions de modification

ATTENTION

Tenez compte de ces informations générales. Il n’est pas prévu de modifier quoi que ce soit ici (car le marquage dans le référentiel indique qu’il s’agit d’une zone privée). Cependant, ces éléments peuvent être utiles, dans certains cas, pour comprendre dans le détail comment les choses fonctionnent.

La modification d’un fragment de contenu qui peut être réparti sur plusieurs vues (= pages HTML) est atomique. Comme les fonctionnalités d’édition à vues multiples atomiques ne sont pas un concept AEM classique, les fragments de contenu utilisent un processus appelé session de modification.

Une session de modification est lancée lorsque l’utilisateur ouvre un fragment de contenu dans l’éditeur. La session de modification est terminée lorsque l’utilisateur quitte l’éditeur en sélectionnant Enregistrer ou Annuler.

Techniquement, toutes les modifications sont effectuées sur du contenu dynamique, comme pour toute autre modification dans AEM. Lorsque la session de modification est lancée, une version de l’état actuel non modifié est créée. Si un utilisateur annule une modification, cette version est restaurée. Si l’utilisateur clique sur Enregistrer, rien de spécifique n’est fait, car toutes les modifications ont été exécutées sur le contenu en dynamique. Toutes les modifications sont donc déjà conservées. En outre, si l’utilisateur clique sur Enregistrer, un traitement en arrière-plan (comme la création d’informations de recherche de texte intégral et/ou la gestion de ressources variées) se déclenche.

Il existe des mesures de sécurité pour les cas limites ; par exemple, si l’utilisateur tente de quitter l’éditeur sans enregistrer ni annuler la session de modification. En outre, un enregistrement automatique périodique est disponible pour empêcher la perte de données.
Notez que deux utilisateurs peuvent modifier simultanément le même fragment de contenu et donc remplacer leurs modifications mutuelles. Pour éviter cela, le fragment de contenu doit être verrouillé en appliquant au fragment l’action Extraction d’administration du système DAM.

Exemples

Exemple : accès à un fragment de contenu existant

Pour ce faire, vous pouvez adapter la ressource qui représente l’API à :

com.adobe.cq.dam.cfm.ContentFragment

Par exemple :

// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
    ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
    // the resource is now accessible through the API
}

Exemple : création d’un fragment de contenu

Pour créer un fragment de contenu par programmation, vous devez utiliser un
modèle FragmentTemplate adapté d’une ressource de modèle.

Par exemple :

Resource modelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = modelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Exemple : spécification de l’intervalle d’enregistrement automatique

L’intervalle d’enregistrement automatique (exprimé en secondes) peut être défini à l’aide de Configuration Manager (ConfMgr) :

  • Nœud : <conf-root>/settings/dam/cfm/jcr:content

  • Nom de la propriété : autoSaveInterval

  • Type : Long

  • Valeur par défaut : 600 (10 minutes) ; cette valeur est définie sur /libs/settings/dam/cfm/jcr:content

Si vous souhaitez définir un intervalle d’enregistrement automatique de 5 minutes, vous devez définir la propriété sur le nœud, par exemple :

  • Nœud : /conf/global/settings/dam/cfm/jcr:content

  • Nom de la propriété : autoSaveInterval

  • Type : Long

  • Valeur : 300 (5 minutes correspondent à 300 secondes).

Composants pour la création de page

Pour en savoir plus, voir

Sur cette page