Principes de recherche search-essentials

Vue d’ensemble overview

La fonction de recherche est une fonctionnalité essentielle de Adobe Experience Manager (AEM) Communities. Outre les fonctionnalités AEM recherche de plateforme, AEM Communities fournit l’ API de recherche UGC pour la recherche de 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 :

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 ombre security-and-shadow-nodes

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 établissent les noeuds fantômes requis et s’assurent 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 ugc-search-api

Le magasin commun UGC est fourni par l’un des différents 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 appelle le langage de requête approprié pour la SRP choisie.

Recherches ASRP asrp-searches

Pour ASRP, le contenu créé par l’utilisateur est stocké dans le cloud d’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 Publish. 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 de recherches, il est nécessaire de respecter les exigences d’attribution de noms.

Recherches MSRP msrp-searches

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

Concernant MSRP et Solr :

Les fonctions de recherche personnalisées doivent utiliser l’ API de recherche UGC.

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

Recherches JSRP jsrp-searches

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

Comme le contenu généré par l’utilisateur est généralement saisi dans l’environnement Publish, 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 Publish n’est jamais visible dans l’environnement de création. Par conséquent, toutes les tâches de modération ont lieu dans l’environnement Publish.

Les fonctions de recherche personnalisées doivent utiliser l’ API de recherche UGC.

Indexation Oak oak-indexing

Bien que les index Oak ne soient pas automatiquement créés pour la recherche de plateforme AEM, à partir d’AEM 6.2, ils ont été ajoutés pour qu’AEM Communities améliore les performances et prenne en charge 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 maintenir la portabilité, respectez les exigences d’attribution de noms 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 à la section Requêtes et indexation Oak.

Oak Index Manager est disponible sous ACS AEM Commons. Elle fournit les éléments suivants :

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

Propriétés de recherche indexées indexed-search-properties

Propriétés de recherche par défaut default-search-properties

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 naming-of-custom-properties

Lors de l’ajout de propriétés personnalisées, pour que ces propriétés soient 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 :

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

Remarques:

Filtres filters

Les composants, qui incluent le système de commentaires, prennent en charge le paramètre de filtre en plus de 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) :

L’implémentation par défaut du composant Recherche utilise cette syntaxe, comme on peut 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é :

Outils SRP srp-tools

Il existe un projet Adobe Experience 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 peut supprimer tout le contenu généré 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 troubleshooting

Requête Solr solr-query

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’affiche 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 related-resources