Implementazione della denominazione delle pagine lato server per Analytics

Adobe Analytics utilizza s.pageName per identificare in modo univoco le pagine e associare i dati raccolti per le pagine. In genere, per assegnare un valore a questa proprietà che l’AEM invia ad Analytics, esegui le seguenti attività in AEM:

• Utilizza il framework del servizio cloud Analytics per mappare una variabile CQ su Analytics s.pageName proprietà. (vedere Mappatura dei dati dei componenti con le proprietà di Adobe Analytics.)

• Progetta il componente Pagina in modo che includa la variabile CQ mappata sul s.pageName proprietà. (vedere Implementazione del tracciamento di Adobe Analytics per i componenti personalizzati.)

Per esporre i dati dei rapporti di Analytics nella console Sites e in Content Insight, l’AEM richiede il valore della proprietà s.pageName per ogni pagina. L’API Java di AEM Analytics definisce AnalyticsPageNameProvider che implementate per fornire alla console Sites e a Content Insights il valore della s.pageName proprietà. Il tuo AnaltyicsPageNameProvider Il servizio risolve la proprietà pageName sul server a scopo di reporting, in quanto può essere impostata dinamicamente utilizzando JavaScript sul client a scopo di tracciamento.

Servizio provider nome pagina di Analytics predefinito

Il DefaultPageNameProvider è il servizio predefinito che determina il valore del s.pageName da utilizzare per recuperare i dati di Analytics per una pagina. Il servizio funziona in combinazione con il componente pagina della fondazione AEM ( /libs/foundation/components/page). Questo componente pagina definisce le seguenti variabili CQ da mappare al s.pageName proprietà:

• pagedata.path: il valore viene impostato sul percorso della pagina.
• pagedata.title: il valore viene impostato sul titolo della pagina.
• pagedata.navTitle: il valore viene impostato sul titolo di navigazione della pagina.

Il DefaultPageNameProvider servizio determina quale di queste variabili CQ è mappata al s.pageName nel framework del servizio cloud Analytics. Il servizio determina quindi la proprietà di pagina appropriata da utilizzare per recuperare i dati del rapporto di analisi:

• pagedata.path: il servizio utilizza page.getPath()

• pagedata.title: il servizio utilizza page.getTitle()

• pagedata.navTitle: il servizio utilizza page.getNavigationTitle()

Il page l'oggetto è l'oggetto è com.day.cq.wcm.api.Page Oggetto Java per la pagina.

Se non mappi una variabile CQ su s.pageName nel framework, il valore per s.pageName viene generato dal percorso della pagina. Ad esempio, la pagina con il percorso /content/geometrixx/en utilizza il valore content:geometrixx:en per s.pageName.

Mantenimento della continuità nel reporting di Analytics

Per mantenere una cronologia completa dei dati di analisi per una pagina, è necessario che il valore della proprietà s.pageName utilizzata per una pagina non cambi mai. Tuttavia, le proprietà di analisi definite dal componente della pagina di base possono essere facilmente modificate. Ad esempio, lo spostamento di una pagina cambia il valore di pagedata.path e interrompe la continuità della cronologia di reporting:

• I dati raccolti per il percorso precedente non sono più associati alla pagina.
• Se una pagina diversa utilizza il percorso utilizzato un’altra pagina, tale pagina eredita i dati per tale percorso.

Per garantire la continuità della generazione dei rapporti, il valore di s.pageName deve avere le seguenti caratteristiche:

• Univoco.
• Stabile.
• Leggibile.

Ad esempio, un componente pagina personalizzato può includere una proprietà di pagina utilizzata dagli autori per specificare un ID univoco per la pagina da utilizzare come valore per s.pageProperties proprietà:

• La pagina include una variabile di analisi impostata sul valore dell’ID univoco memorizzato nella proprietà della pagina.
• La variabile di analisi è mappata su s.pageProperties nel framework Analytics.
• L’implementazione dell’interfaccia AnalyticsPageNameProvider recupera il valore della proprietà della pagina da utilizzare per l’esecuzione di query sui dati di Analytics della pagina.

Implementazione di un servizio provider del nome della pagina di Analytics

Implementare com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider come servizio OSGi per personalizzare la logica che recupera il s.pageName valore della proprietà. Le funzioni di analisi della pagina Sites e Insight sui contenuti utilizzano il servizio per recuperare i dati dei rapporti da Analytics.

L'interfaccia AnalyticsPageNameProvider definisce due metodi che è necessario implementare:

• getPageName: restituisce un String valore che rappresenta il valore da utilizzare come s.pageName proprietà.

• getResource: restituisce un org.apache.sling.api.resource.Resource oggetto che rappresenta la pagina associata al s.pageName proprietà.

Entrambi i metodi richiedono un com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext come parametro. Il AnalyticsPageNameContext la classe fornisce informazioni sul contesto delle chiamate di analytics:

• Percorso di base della risorsa della pagina.
• Il Framework oggetto per la configurazione del servizio cloud Analytics.
• Il Resource per la pagina.
• Il ResourceResolver per la pagina.

La classe fornisce anche un setter per il nome della pagina.

Esempio di implementazione di AnalyticsPageNameProvider

Il seguente esempio AnalyticsPageNameProvider l’implementazione supporta un componente pagina personalizzato:

• Il componente estende il componente pagina di base.
• La finestra di dialogo include un campo utilizzato dagli autori per specificare il valore del s.pageName proprietà.
• Il valore della proprietà viene memorizzato nella proprietà pageName del jcr:contentnodo delle istanze della pagina.
• La proprietà di analisi che memorizza il s.pageName la proprietà è chiamata pagedata.pagename. Questa proprietà è mappata al s.pageName nel framework Analytics.

La seguente attuazione del getPageName Il metodo restituisce il valore della proprietà del nodo pageName se il mapping del framework è configurato correttamente:

public String getPageName(AnalyticsPageNameContext context) {
        String pageName = null;

        Framework framework = context.getFramework();
        Resource resource = context.getResource();

        if (resource != null && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            Page page = resource.adaptTo(Page.class);
            if (cqVar.equals("pagedata.pagename")) {
                pageName = page.getProperties().get("pageName",null);
            }
        }
        return pageName;
    }

La seguente implementazione del metodo getResource restituisce l'oggetto Resource per la pagina:

     public Resource getResource(AnalyticsPageNameContext context) {
        Resource res = null;

        Framework framework = context.getFramework();
        ResourceResolver resolver = context.getResourceResolver();
        String pageName = context.getPageName();
        String basePath = context.getBasePath();

        if (pageName != null && basePath != null && resolver != null
                && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            if (cqVar.equals("pagedata.pagename")) {
             Iterator<Resource>
             hits = resolver.findResources(createQuery(pageName, basePath, "pagename"), Query.JCR_SQL2);
             if (hits.hasNext()) {
              res = hits.next();
              res = res.getParent();
             }
            }
        }
        return res;
    }

    private String createQuery(String pageName, String basePath, String propName) {
        return "SELECT * FROM [cq:PageContent] WHERE ISDESCENDANTNODE(["
                + basePath + "]) and [" + propName + "] = \"" + pageName + "\"";
    }

Il codice seguente rappresenta l’intera classe, incluse le annotazioni SCR che configurano il servizio. La classificazione del servizio è 200 e sostituisce il servizio predefinito.

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 * Copyright 2019 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.day.cq.analytics.sitecatalyst;

import java.util.Iterator;

import javax.jcr.query.Query;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.osgi.framework.Constants;
import org.osgi.service.component.annotations.Component;

import com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext;
import com.day.cq.analytics.sitecatalyst.AnalyticsPageNameProvider;
import com.day.cq.analytics.sitecatalyst.Framework;
import com.day.cq.wcm.api.Page;

import static com.day.cq.analytics.sitecatalyst.AnalyticsPageNameContext.S_PAGE_NAME;

/**
 * Default implementation of {@link AnalyticsPageNameProvider} that resolves
 * page title, path or navTitle if mapped in {@link Framework}.
 */
@Component(
    service = { AnalyticsPageNameProvider.class },
    property = {
        Constants.SERVICE_DESCRIPTION + "=Example Page Name Resolver implementation",
        Constants.SERVICE_RANKING + ":Integer=200"
    }
)
public class ExamplePageNameProvider implements AnalyticsPageNameProvider {
    public String getPageName(AnalyticsPageNameContext context) {
        String pageName = null;

        Framework framework = context.getFramework();
        Resource resource = context.getResource();

        if (resource != null && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            Page page = resource.adaptTo(Page.class);
            if (cqVar.equals("pagedata.path")) {
                pageName = page.getProperties().get("pageName",null);
            }
        }
        return pageName;
    }

    public Resource getResource(AnalyticsPageNameContext context) {
        Resource res = null;

        Framework framework = context.getFramework();
        ResourceResolver resolver = context.getResourceResolver();
        String pageName = context.getPageName();
        String basePath = context.getBasePath();

        if (pageName != null && basePath != null && resolver != null
                && framework != null && framework.mapsSCVariable(S_PAGE_NAME)) {
            String cqVar = framework.getMapping(S_PAGE_NAME);
            if (cqVar.equals("pagedata.pagename")) {
                Iterator<Resource>
                hits = resolver.findResources(createQuery(pageName, basePath, "pagename"), Query.JCR_SQL2);
                if (hits.hasNext()) {
                    res = hits.next();
                    res = res.getParent();
                }
            }
        }
        return res;
    }

    private String createQuery(String pageName, String basePath, String propName) {
        return "SELECT * FROM [cq:PageContent] WHERE ISDESCENDANTNODE(["
                + basePath + "]) and [" + propName + "] = \"" + pageName + "\"";
    }
}