Utilizzo di Best Practices Analyzer

Considerazioni importanti sull’utilizzo di Best Practices Analyzer

La sezione seguente per contiene considerazioni importanti sull’esecuzione di Best Practices Analyzer (BPA):

• Il rapporto BPA viene creato utilizzando l’output del Adobe Experience Manager (AEM) Rilevatore pattern. La versione del rilevatore pattern utilizzata da BPA è inclusa nel pacchetto di installazione di BPA.

• BPA può essere eseguito solo da admin utente o un utente in amministratori gruppo.

• BPA è supportato sulle istanze AEM con versione 6.1 e successive.

  NOTA

  Consulta Installazione su AEM 6.1 per requisiti speciali per l’installazione di BPA su AEM 6.1.

• BPA può essere eseguito in qualsiasi ambiente, ma è preferibile eseguirlo su un Fase ambiente.

  NOTA

  Per evitare un impatto sulle istanze aziendali critiche, si consiglia di eseguire BPA su un Autore ambiente il più vicino possibile al Produzione nelle aree di personalizzazioni, configurazioni, contenuti e applicazioni utente. In alternativa, può essere eseguito su un clone dell’ambiente di authoring di produzione.

• La generazione del contenuto del rapporto BPA può richiedere molto tempo, da alcuni minuti ad alcune ore. Il tempo richiesto dipende in larga misura dalle dimensioni e dalla natura del contenuto dell’archivio AEM, dalla versione di AEM e da altri fattori.

• A causa del tempo significativo che potrebbe essere necessario per generare il contenuto del rapporto, il processo avviene in background e viene mantenuto nella cache. La visualizzazione e il download del rapporto dovrebbero essere relativamente veloci poiché viene utilizzata la cache del contenuto fino alla scadenza o all’aggiornamento esplicito del rapporto. Durante la generazione del contenuto del rapporto puoi chiudere la scheda del browser e tornare in un secondo momento per visualizzare il rapporto una volta che il relativo contenuto è disponibile nella cache.

Disponibilità

Best Practices Analyzer può essere scaricato come file zip dal portale di distribuzione software. È possibile installare il pacchetto tramite Gestione pacchetti nell’istanza Adobe Experience Manager (AEM) di origine.

Visualizzazione del rapporto di Best Practices Analyzer

Adobe Experience Manager 6.3.0 e versioni successive

Segui questa sezione per scoprire come visualizzare il rapporto Best Practices Analyzer:

1. Seleziona Adobe Experience Manager e passa a Strumenti > Operazioni > Best Practices Analyzer.

   

2. Clic Genera report per eseguire Best Practices Analyzer.

   

3. Durante la generazione del rapporto da parte di BPA, è possibile visualizzare lo stato di avanzamento dello strumento sullo schermo. Visualizza il numero di elementi analizzati e il numero di risultati trovati.

   

4. Una volta generato, il rapporto BPA visualizza un riepilogo e il numero dei risultati in formato tabulare organizzato in base al tipo di risultato e al livello di importanza. Per ottenere ulteriori dettagli su un particolare risultato, è possibile fare clic sul numero corrispondente al tipo di risultato nella tabella.

   

   L’azione precedente scorre automaticamente fino alla posizione del risultato nel rapporto.

   

5. Puoi scaricare il rapporto in formato CSV facendo clic su Esporta in CSV, come illustrato nella figura seguente.

   

   NOTA

   Per cancellare la cache e rigenerare il rapporto, fai clic su Aggiorna report.

   

   NOTA

   Durante la rigenerazione, il rapporto mostra l’avanzamento in termini di percentuale di completamento, come illustrato nell’immagine seguente.

   

Utilizzo dei filtri nel rapporto di Best Practices Analyzer

Per filtrare i risultati relativi a Commons ACS, effettua le seguenti operazioni:

1. Fai clic sull’icona della barra a sinistra nella pagina. Verrà visualizzata la ACS Commons Filter. Fai clic su ACS Commons Filter per visualizzare la casella di controllo interattiva, come illustrato nell'immagine seguente.

   

   NOTA

   L’icona della barra a sinistra viene visualizzata solo se BPA rileva l’utilizzo di ACS Commons.

2. Deseleziona la casella per escludere tutti i risultati relativi ad ACS Commons. Dovresti vedere un Conteggio risultati filtrati sul rapporto, come illustrato nell’immagine seguente. Il filtro viene applicato anche al rapporto quando viene esportato in formato CSV (Virgola-Separated-Value).

   

   NOTA

   I risultati di ACS Commons non devono essere ignorati. Consulta documentazione per determinare la compatibilità con AEM as a Cloud Service.

Interpretazione del rapporto di Best Practices Analyzer

Quando lo strumento Best Practices Analyzer viene eseguito nell’istanza AEM, il rapporto viene visualizzato come risultati nella finestra dello strumento.

Il rapporto si presenta con questo formato:

• Panoramica rapporto: informazioni sul rapporto stesso, tra cui:
  • Data del rapporto: quando il contenuto del rapporto è stato generato e reso disponibile per la prima volta.
  • Data di scadenza: quando scade la cache del contenuto del rapporto.
  • Tempo di generazione: tempo impiegato dal processo di generazione del contenuto del rapporto.
  • Conteggio risultati: numero totale di risultati inclusi nel rapporto.
• Panoramica del sistema: informazioni sul sistema AEM su cui è stato eseguito il BPA.
• Categorie dei risultati: diverse sezioni che riguardano ciascuna uno o più risultati della stessa categoria. Ogni sezione include quanto segue: nome della categoria, sottotipi, conteggio e importanza dei risultati, riepilogo, collegamento alla documentazione della categoria e informazioni su singoli risultati.

A ciascun risultato viene assegnato un livello di importanza per dare un’indicazione approssimativa del grado di priorità dell’intervento richiesto.

La tabella seguente descrive i livelli di importanza:

Interpretazione del rapporto CSV di Best Practices Analyzer

Quando fai clic su CSV dall’istanza dell’AEM, il rapporto Best Practices Analyzer in formato CSV viene creato dalla cache del contenuto e restituito al browser. A seconda delle impostazioni del browser, questo report viene scaricato automaticamente come file con il nome predefinito results.csv.

Se la cache è scaduta, il rapporto viene rigenerato prima che il file CSV venga generato e scaricato.

Il formato CSV del rapporto include informazioni generate dall’output del rilevatore pattern, ordinate e organizzate per tipo di categoria, sottotipo e livello di importanza. Il formato è adatto alla visualizzazione e la modifica in un’applicazione come Microsoft Excel. Lo scopo è quello di fornire tutte le informazioni sui risultati in un formato ripetibile che può essere utile quando si confrontano i rapporti nel tempo per misurare l’avanzamento.

Le colonne del rapporto in formato CSV sono:

• code (codice): codice della categoria
• type (tipo): nome della categoria
• subtype (sottotipo): sottotipo della categoria
• importance (importanza): livello di importanza
• identifier (identificatore): identificatore principale del risultato
• other (altro): ulteriori informazioni sul risultato
• message (messaggio): messaggio fornito per il risultato
• moreInfo (ulteriori informazioni): collegamento che consente di accedere alla sezione sulla categoria in oggetto nella guida online
• context (contesto): una stringa JSON contenente dati sul risultato

Un valore “\N” in una colonna di un singolo risultato indica che non sono stati forniti dati.

Interfaccia HTTP

Il BPA fornisce un’interfaccia HTTP che può essere utilizzata come alternativa alla sua interfaccia utente nell’ambito dell’AEM. L’interfaccia supporta sia i comandi HEAD che GET. Può essere utilizzato per generare il rapporto BPA e restituirlo in uno dei tre formati seguenti: JSON, CSV e valori delimitati da tabulazioni (TSV).

I seguenti URL sono disponibili per l’accesso HTTP, dove <host> è il nome host, e se necessario la porta, del server in cui è installato BPA:

• http://<host>/apps/best-practices-analyzer/analysis/report.json per il formato JSON
• http://<host>/apps/best-practices-analyzer/analysis/report.csv per il formato CSV
• http://<host>/apps/best-practices-analyzer/analysis/report.tsv per il formato TSV

Esecuzione di una richiesta HTTP

L’interfaccia HTTP può essere utilizzata in diversi modi.

Un modo semplice consiste nell’aprire una scheda del browser nello stesso browser in cui hai già effettuato l’accesso ad AEM come amministratore. Puoi inserire l’URL nella scheda del browser e visualizzare o scaricare i risultati dal browser.

È inoltre possibile utilizzare uno strumento della riga di comando, ad esempio curl o wget e qualsiasi applicazione client HTTP. Se non utilizzi una scheda del browser con una sessione autenticata, devi fornire nel commento un nome utente e una password amministratore.

Il seguente è un esempio di come eseguire questa operazione:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv.

Intestazioni e parametri

Le seguenti intestazioni HTTP sono utilizzate da questa interfaccia:

• Cache-Control: max-age=<seconds>: specifica l’intervallo di aggiornamento della cache in secondi. (consulta RFC 7234).
• Prefer: respond-async: specifica che il server deve rispondere in modo asincrono. (consulta RFC 7240).
• Prefer: return=minimal: specifica che il server deve restituire una risposta minima. (consulta RFC 7240).

I seguenti parametri di query HTTP sono disponibili per comodità nei casi in cui le intestazioni HTTP potrebbero non essere facilmente utilizzate:

• max-age (numero, facoltativo): specifica l’intervallo di aggiornamento della cache in secondi. Questo numero deve essere maggiore o uguale a 0. L'intervallo di aggiornamento predefinito è di 86400 secondi. Senza questo parametro o l’intestazione corrispondente, viene utilizzata una nuova cache per distribuire le richieste per 24 ore, momento in cui la cache deve essere rigenerata. Utilizzo di max-age=0 forza la cancellazione della cache e avvia la rigenerazione del rapporto, utilizzando l’intervallo di aggiornamento precedente diverso da zero per la cache appena generata.
• respond-async (booleano, facoltativo): specifica che la risposta deve essere fornita in modo asincrono. Utilizzo di respond-async=true quando la cache non è aggiornata, il server restituirà una risposta di 202 Accepted senza attendere l’aggiornamento della cache e la generazione del rapporto. Se la cache è aggiornata, questo parametro non ha alcun effetto. Il valore predefinito è false. Senza questo parametro o l’intestazione corrispondente, il server risponderà in modo sincrono, il che potrebbe richiedere molto tempo e un adeguamento del tempo di risposta massimo per il client HTTP.
• may-refresh-cache (booleano, facoltativo): specifica che il server può aggiornare la cache in risposta a una richiesta se la cache corrente è vuota, non aggiornata o non aggiornata. Se may-refresh-cache=trueoppure, se non è specificato, il server potrebbe avviare un'attività in background che richiamerà il rilevatore pattern e aggiornerà la cache. Se may-refresh-cache=false il server non avvierà quindi alcuna attività di aggiornamento che altrimenti sarebbe stata eseguita se la cache fosse stata vuota o non aggiornata, nel qual caso il report è vuoto. Questo parametro non influisce su eventuali attività di aggiornamento già in corso.
• return-minimal (booleano, facoltativo): specifica che la risposta dal server deve includere solo lo stato contenente l’indicazione di avanzamento e lo stato della cache in formato JSON. Se return-minimal=true, il corpo della risposta è limitato all’oggetto stato. Se return-minimal=false, o se non è specificato, viene fornita una risposta completa.
• log-findings (booleano, facoltativo): specifica che il server deve registrare il contenuto della cache quando viene generato o aggiornato per la prima volta. Ogni risultato dalla cache viene registrato come stringa JSON. Questa registrazione verrà eseguita solo se log-findings=true e la richiesta genera una nuova cache.

Se sono presenti sia un’intestazione HTTP che il parametro di query corrispondente, il parametro di query avrà la priorità.

Un modo semplice per avviare la generazione del rapporto tramite l’interfaccia HTTP è l’utilizzo del seguente comando:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'.

Una volta effettuata la richiesta, non c’è bisogno che il client rimanga attivo affinché venga generato il rapporto. La generazione del rapporto può essere avviata con un client utilizzando una richiesta HTTP GET e, una volta generato, può essere visualizzato dalla cache con un altro client o con lo strumento BPA nell’interfaccia utente AEM.

Risposte

Sono possibili i seguenti valori di risposta:

• 200 OK: indica che la risposta contiene i risultati del rilevatore pattern generati quando la cache era aggiornata.
• 202 Accepted: utilizzato per indicare che la cache non è aggiornata. Quando respond-async=true e may-refresh-cache=true questa risposta indica che è in corso un'attività di aggiornamento. Quando may-refresh-cache=false questa risposta indica semplicemente che la cache non è aggiornata.
• 400 Bad Request: indica che la richiesta ha restituito un errore. Un messaggio nel formato Dettagli del problema (vedere RFC 7807) fornisce ulteriori dettagli.
• 401 Unauthorized: indica che la richiesta non è stata autorizzata.
• 500 Internal Server Error: indica che si è verificato un errore interno del server. Un messaggio nel formato Dettagli del problema fornisce ulteriori dettagli.
• 503 Service Unavailable: indica che il server è occupato con un’altra risposta e non può soddisfare questa richiesta in modo tempestivo. È probabile che ciò si verifichi solo quando vengono effettuate richieste sincrone. Un messaggio nel formato Dettagli del problema fornisce ulteriori dettagli.

Informazioni per l’amministratore

Regolazione durata cache

La durata predefinita della cache BPA è di 24 ore. Con l’opzione per aggiornare un rapporto e rigenerare la cache, sia nell’istanza AEM che nell’interfaccia HTTP, questo valore predefinito è probabilmente appropriato per la maggior parte degli usi del BPA. Se il tempo di generazione del rapporto è particolarmente lungo per la tua istanza AEM, puoi regolare la durata della cache per ridurre al minimo la rigenerazione del rapporto.

Il valore della durata della cache viene memorizzato come la proprietà maxCacheAge nel seguente nodo di archivio:
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

Il valore di questa proprietà corrisponde alla durata della cache, in secondi. Un amministratore può regolare la durata della cache utilizzando CRX/DE Lite.

Installazione su AEM 6.1

BPA utilizza un account utente del servizio di sistema denominato repository-reader-service per eseguire il rilevatore pattern. Questo account è disponibile in AEM 6.2 e versioni successive. In AEM 6.1, questo account deve essere creato prima di l’installazione di BPA, procedendo come segue:

1. Per creare un utente segui le istruzioni in Creazione di un nuovo utente di servizio. Imposta UserID su repository-reader-service e lascia vuoto il Percorso intermedio, quindi fai clic sul segno di spunta verde.

2. Segui le istruzioni riportate nella sezione Gestione di utenti e gruppi, in particolare Aggiunta di utenti a un gruppo, per aggiungere l’utente repository-reader-service al gruppo administrators.

3. Installa il pacchetto BPA tramite Gestione pacchetti nell’istanza AEM di origine. Questa azione aggiunge la necessaria modifica alla configurazione ServiceUserMapper per l’utente di servizio del sistema repository-reader-service.)