Notions fondamentales sur la recherche

Présentation

La fonctionnalité de recherche est une fonctionnalité essentielle d’AEM Communities. Outre les fonctionnalités AEM recherche de plateforme, AEM Communities fournit l’API de recherche UGC dans le but de rechercher du contenu généré par l’utilisateur. Le contenu généré par l’utilisateur possède des propriétés uniques, car il est saisi et stocké séparément du contenu AEM et des données utilisateur.

Pour Communities, les deux éléments généralement recherchés sont les suivants :

• Contenu publié par des membres de la communauté

  • Utilise l’API de recherche UGC d’AEM Communities

• Utilisateurs et groupes d’utilisateurs (données utilisateur)

  • Utilise les fonctionnalités de recherche de plateforme AEM

Cette section de la documentation intéresse les développeurs qui créent des composants personnalisés qui créent ou gèrent du contenu généré par l’utilisateur.

Noeuds de sécurité et ombres

Pour un composant personnalisé, il est nécessaire d’utiliser les méthodes SocialResourceUtilities. Les méthodes d’utilitaire qui créent et recherchent le contenu généré par l’utilisateur établiront les noeuds fantômes requis et s’assureront que le membre dispose des autorisations appropriées pour la requête.

Les propriétés qui ne sont pas gérées par les utilitaires SRP sont liées à la modération.

Voir SRP et UGC Essentials pour plus d’informations sur les méthodes d’utilitaire utilisées pour accéder aux noeuds fantômes UGC et ACL.

API de recherche UGC

Le magasin commun UGC est fourni par l’un des divers fournisseurs de ressources de stockage (SRP), chacun pouvant avoir un langage de requête natif différent. Par conséquent, quel que soit la SRP choisie, le code personnalisé doit utiliser des méthodes du package de l’API UGC (com.adobe.cq.social.ugc.api) qui appelleront le langage de requête approprié pour la SRP choisie.

Recherches ASRP

Pour ASRP, le contenu généré par l’utilisateur est stocké dans le cloud Adobe. Bien que le contenu généré par l’utilisateur ne soit pas visible dans CRX, la modération est disponible dans les environnements de création et de publication. L’utilisation de l’API de recherche UGC fonctionne pour ASRP de la même manière que pour les autres SRP.

Il n’existe actuellement aucun outil pour gérer les recherches ASRP.

Lors de la création de propriétés personnalisées pouvant faire l’objet d’une recherche, il est nécessaire de respecter les exigences d’attribution de noms.

Recherches MSRP

Pour MSRP, le contenu généré par l’utilisateur est stocké dans MongoDB configuré pour utiliser Solr pour la recherche. Le contenu généré par l’utilisateur ne sera pas visible dans CRX, mais la modération est disponible dans les environnements de création et de publication.

À propos de MSRP et Solr :

• Le Solr incorporé pour la plateforme AEM n’est pas utilisé pour MSRP.
• Si vous utilisez un Solr distant pour la plateforme AEM, il peut être partagé avec MSRP, mais il doit utiliser des collections différentes.
• Solr peut être configuré pour la recherche standard ou pour la recherche multilingue (MLS).
• Pour plus d’informations sur la configuration, voir Configuration Solr pour MSRP

Les fonctionnalités de recherche personnalisée doivent utiliser l’API de recherche UGC.

Lors de la création de propriétés personnalisées pouvant faire l’objet d’une recherche, il est nécessaire de respecter les exigences d’attribution de noms.

Recherches JSRP

Pour JSRP, le contenu généré par l’utilisateur est stocké dans Oak et n’est visible que dans le référentiel de l’instance d’auteur ou de publication AEM sur laquelle il a été saisi.

Comme le contenu généré par l’utilisateur est généralement saisi dans l’environnement de publication, pour les systèmes de production multi-éditeurs, il est nécessaire de configurer une grappe de publication, et non une ferme de publication, de sorte que le contenu saisi soit visible par tous les éditeurs.

Pour JSRP, le contenu généré par l’utilisateur entré dans l’environnement de publication ne sera jamais visible dans l’environnement de création. Par conséquent, toutes les tâches de modération ont lieu dans l’environnement de publication.

Les fonctionnalités de recherche personnalisée doivent utiliser l’API de recherche UGC.

Indexation Oak

Bien que les index Oak ne soient pas automatiquement créés pour la recherche de plateforme AEM, à partir de la version 6.2 d’AEM, ils ont été ajoutés pour qu’AEM Communities améliore les performances et fournisse la prise en charge de la pagination lors de la présentation des résultats de recherche UGC.

Si des propriétés personnalisées sont utilisées et que les recherches sont lentes, des index supplémentaires doivent être créés pour les propriétés personnalisées afin de les rendre plus performantes. Pour préserver la portabilité, respectez les exigences en matière de nommage lors de la création de propriétés personnalisées pouvant faire l’objet de recherches.

Pour modifier des index existants ou créer des index personnalisés, reportez-vous aux sections Requêtes Oak et Indexation.

Oak Index Manager est disponible à partir d’ACS AEM Commons. Il fournit les éléments suivants :

• Une vue des indices existants
• Possibilité d’initier la réindexation

Pour afficher les index Oak existants dans CRXDE Lite, l’emplacement est le suivant :

• /oak:index/socialLucene

Propriétés de recherche indexée

Propriétés de recherche par défaut

Vous trouverez ci-dessous quelques-unes des propriétés pouvant faire l’objet de recherches utilisées pour différentes fonctionnalités de Communities :

Dénomination des propriétés personnalisées

Lors de l’ajout de propriétés personnalisées, afin que ces propriétés puissent être visibles pour les recherches et le tri créés avec l’API de recherche UGC, il est obligatoire d’ajouter un suffixe au nom de la propriété.

Le suffixe est destiné aux langages de requête qui utilisent un schéma :

• Il identifie la propriété comme pouvant faire l’objet d’une recherche.
• Il identifie le type de données

Solr est un exemple de langage de requête qui utilise un schéma.

Remarques:

• **Les SMS sont une chaîne en unités lexicales, ** Chaîne non plus. Utilisez Texte pour des recherches approximatives (plus comme celle-ci).

• Pour les types à plusieurs valeurs, ajoutez "s" au suffixe, par exemple :

  • viewDate_dt: propriété de date unique
  • viewDates_dts: listdates, propriété

Filtres

Les composants qui incluent le système de commentaires prennent en charge l’ajout du paramètre de filtre à leurs points de terminaison.

La syntaxe du filtre pour la logique ET et OU est exprimée comme suit (affichée avant d’être codée au format URL) :

• Pour spécifier OU, utilisez un paramètre de filtre avec des valeurs séparées par des virgules :

  • filter=name eq 'Jennifer',name eq 'Jen'

• Pour spécifier ET, utilisez plusieurs paramètres de filtre :

  • filter = name eq 'Jackson'&filter=message eq 'testing'

L’implémentation par défaut du composant de recherche utilise cette syntaxe, comme vous pouvez le voir dans l’URL qui ouvre la page Résultats de la recherche dans le Guide des composants de la communauté. Pour tester, accédez à http://localhost:4503/content/community-components/en/search.html.

Les opérateurs de filtre sont les suivants :

Il est important que l’URL référence le composant Communities (ressource) et non la page sur laquelle le composant est placé :

• Correct : composant de forum
  • /content/community-components/en/forum/jcr:content/content/forum.social.json
• Incorrect : page de forum
  • /content/community-components/en/forum.social.json

Outils SRP

Il existe un projet Adobe Marketing Cloud GitHub qui contient :

Outils AEM Communities SRP

Ce référentiel contient des outils pour gérer les données dans la SRP.

Actuellement, il existe un servlet qui permet de supprimer tout le contenu créé par l’utilisateur de n’importe quelle SRP.

Par exemple, pour supprimer tout le contenu généré par l’utilisateur dans ASRP :

curl -X POST http://localhost:4502/services/social/srp/cleanup?path=/content/usergenerated/asi/cloud -uadmin:admin

Résolution des problèmes

Requête Solr

Pour résoudre les problèmes liés à une requête Solr, activez la journalisation DEBUG pour

com.adobe.cq.social.srp.impl.SocialSolrConnector.

La requête Solr réelle s’affichera sous forme d’URL encodée dans le journal de débogage :

La requête à résoudre est : sort=timestamp+desc&bl=en&pl=en&start=0&rows=10 &q=%2Btitle_t:(hello)+%2Bprovider_id:\/content/usergenerated/asi/mongo/content/+%2Bresource_type_s:&df=provider_id&trf=verbatim&fq={!cost%3D100}report_suite:mongo

La valeur du paramètre q est la requête. Une fois le codage de l’URL décodé, la requête peut être transmise à l’outil Solr Admin Query pour un débogage plus poussé.

Ressources connexes

• Stockage de contenu de la communauté : discute des choix de SRP disponibles pour un magasin commun UGC.
• Présentation du fournisseur de ressources de stockage - Présentation et utilisation du référentiel
• Accès au contenu généré par l’utilisateur avec SRP - Instructions de codage
• Refactorisation de SocialUtils : méthodes utilitaires de SRP qui remplacent SocialUtils
• Composants Résultats de recherche - Ajout d’une fonctionnalité de recherche UGC à un modèle