Använda Best Practices Analyzer

Viktigt att tänka på när du använder Best Practices Analyzer

Följ avsnittet nedan om du vill veta mer om viktiga aspekter av att köra Best Practices Analyzer (BPA):

  • BPA-rapporten byggs med utdata från Adobe Experience Manager (AEM) Mönsteravkännare. Den version av Mönsteravkännare som används av BPA ingår i BPA-installationspaketet.

  • BPA kan bara köras av admin användare eller användare i administratörer grupp.

  • BPA stöds på AEM med version 6.1 och senare.

    OBSERVERA

    Se Installera på AEM 6.1 för särskilda krav för installation av BPA på AEM 6.1.

  • BPA kan köras i alla miljöer, men det är bäst att det körs på en Scen miljö.

    OBSERVERA

    För att undvika att affärskritiska instanser påverkas rekommenderar vi att du kör BPA på en Upphovsman miljö som är så nära Produktion miljö när det gäller anpassningar, konfigurationer, innehåll och användarprogram. Alternativt kan det köras på en klon av författarmiljön i produktion.

  • Det kan ta lång tid att generera BPA-rapportinnehåll, från flera minuter till några timmar. Hur lång tid som krävs beror i hög grad på storlek och typ av AEM-databasinnehåll, AEM-version och andra faktorer.

  • På grund av den tid som kan krävas för att generera rapportinnehållet, genereras det av en bakgrundsprocess och lagras i ett cacheminne. Det bör gå relativt snabbt att visa och hämta rapporten eftersom den använder innehållscachen tills den upphör att gälla eller tills rapporten uttryckligen uppdateras. Under genereringen av rapportinnehållet kan du stänga webbläsarfliken och sedan gå tillbaka och visa rapporten när innehållet är tillgängligt i cachen.

Tillgänglighet

Best Practices Analyzer kan laddas ned som en zip-fil från portalen för programvarudistribution. Du kan installera paketet via Pakethanteraren på din källinstans av Adobe Experience Manager (AEM).

OBSERVERA

Hämta Best Practices Analyzer från Programvarudistribution portal.

Visa rapporten Best Practices Analyzer

Adobe Experience Manager 6.3.0 och senare

Följ det här avsnittet för att lära dig hur du visar rapporten Best Practices Analyzer:

  1. Välj Adobe Experience Manager och navigera till verktyg -> Operationer -> Best Practices Analyzer.

    bild

  2. Klicka på Generera rapport för att köra Best Practices Analyzer.

    bild

  3. Medan BPA genererar rapporten kan du se hur verktyget utvecklas på skärmen. Här visas antalet analyserade objekt och även antalet upptäckter.

    bild

  4. När BPA-rapporten har genererats visas en sammanfattning och antalet resultat i tabellformat, ordnade efter typ av fynd och prioritetsnivå. Om du vill ha mer information om en viss sökning kan du klicka på talet som motsvarar sökningstypen i tabellen.

    bild

    Ovanstående åtgärd rullar automatiskt till platsen för sökningen i rapporten.

    bild

  5. Du kan hämta rapporten i ett kommaavgränsat värdeformat (CSV) genom att klicka på Exportera till CSV, vilket visas i figuren nedan.

    bild

    OBSERVERA

    Du kan tvinga BPA att rensa cacheminnet och återskapa rapporten genom att klicka på Uppdatera rapport.

    bild

    OBSERVERA

    Medan rapporten återskapas visas förloppet i procent som slutförts enligt bilden nedan.

    bild

Använda filter i rapporten Best Practices Analyzer

Filtrera bort resultat som är relaterade till ACS-kommandonföljer du stegen nedan:

  1. Klicka på ikonen för den vänstra listen till vänster på sidan. Det här visar ACS-kommandofilter. Klicka på ACS-kommandofilter för att visa den interaktiva kryssrutan så som visas i bilden nedan.

    bild

    OBSERVERA

    Ikonen för vänster spår visas bara om BPA upptäcker att ACS Commons används.

  2. Avmarkera rutan om du vill filtrera bort alla resultat som rör ACS-kommandon. Du borde se en Antal filtrerade sökningar på rapporten enligt bilden nedan. Filtret används också i rapporten när den exporteras i ett CSV-format (kommaavgränsat värde).

    bild

    OBSERVERA

    ACS Commons-resultaten ska inte ignoreras. Se dokumentation för att fastställa kompatibiliteten med AEM as a Cloud Service.

Tolka rapporten Best Practices Analyzer

När verktyget Best Practices Analyzer körs i AEM visas rapporten som resultat i verktygsfönstret.

Rapportens format är:

  • Report Overview: Information om själva rapporten med följande information:
    • Report Time: När rapportinnehållet genererades och gjordes tillgängligt för första gången.
    • Expiration Time: När cachen för rapportinnehållet upphör att gälla.
    • Generation Time Period: Den tid det tog att generera rapportinnehållet.
    • Finding Count: Det totala antalet resultat som ingår i rapporten.
  • Systemöversikt: Information om det AEM systemet som BPA kördes på.
  • Finding Categories: Flera avsnitt som vart och ett handlar om ett eller flera resultat i samma kategori. Varje avsnitt innehåller följande: kategorinamn, undertyper, antal resultat och viktighetsgrad, sammanfattning, länk till kategoridokumentation och information om enskilda resultat.

Viktighetsgrad tilldelas varje resultat och anger ungefärlig prioritet för åtgärder.

OBSERVERA

Om du vill veta mer om varje sökkategori kan du läsa Kategorier för mönsteravkännare.

Läs tabellen nedan för mer information om viktighetsgrad:

Viktighetsgrad Beskrivning
INFO Resultatet tillhandahålls i informationssyfte.
ADVISORY Resultatet kan innebära ett uppgraderingsproblem. Ytterligare undersökningar rekommenderas.
MAJOR Detta resultat innebär sannolikt ett uppgraderingsproblem som bör åtgärdas.
CRITICAL Detta resultat innebär sannolikt ett uppgraderingsproblem som måste åtgärdas för att förhindra funktions- eller prestandaproblem.

Tolka CSV-rapporten för Best Practices Analyzer

När du klickar på CSV CSV-formatet i Best Practices Analyzer-rapporten byggs från innehållscachen och returneras till din webbläsare. Beroende på inställningarna i webbläsaren hämtas rapporten automatiskt som en fil med standardnamnet results.csv.

Om cacheminnet har gått ut genereras rapporten på nytt innan CSV-filen skapas och hämtas.

Rapporten i CSV-format innehåller information som genereras med utdata från Pattern Detector och som sorteras och organiseras efter kategorityp, undertyp och viktighetsgrad. Formatet är lämpligt för visning och redigering i program som Microsoft Excel. Avsikten är att ge information om alla resultat i ett upprepningsbart format som kan användas för att jämföra rapporter från olika tidpunkter för att mäta framsteg.

Kolumnerna i rapporten i CSV-format är:

  • code: kategorikoden
  • type: kategorinamnet
  • subtype: undertypen av kategori
  • importance: viktighetsgrad
  • identifier: den primära identifieraren för resultatet
  • other: ytterligare information om resultatet
  • message: det meddelande som tillhandahålls för resultatet
  • moreInfo: en länk som kan användas för att öppna onlinehjälpen för kategorin
  • context: en JSON-sträng med resultatdata

Värdet "\N" i en kolumn för enskilda resultat anger att inga data finns.

HTTP-gränssnitt

BPA har ett HTTP-gränssnitt som kan användas som ett alternativ till användargränssnittet i AEM. Gränssnittet har stöd för både HEAD- och GET-kommandon. Den kan användas för att generera BPA-rapporten och returnera den i ett av tre format: JSON, CSV och tabbseparerade värden (TSV).

Följande URL:er är tillgängliga för HTTP-åtkomst, där <host> är värdnamnet och porten, om det behövs, för servern där BPA är installerat:

  • http://<host>/apps/best-practices-analyzer/analysis/report.json för JSON-format
  • http://<host>/apps/best-practices-analyzer/analysis/report.csv för CSV-format
  • http://<host>/apps/best-practices-analyzer/analysis/report.tsv för TSV-format

Köra en HTTP-begäran

HTTP-gränssnittet kan användas på flera olika sätt.

Ett enkelt sätt är att öppna en webbläsarflik i den webbläsare där du har loggat in i AEM som administratör. Du kan ange URL-adressen på webbläsarfliken och låta webbläsaren visa eller hämta resultat.

Du kan också använda ett kommandoradsverktyg som curl eller wget samt HTTP-klientprogram. Om du inte använder en webbläsarflik med en autentiserad session måste du ange ett administratörsanvändarnamn och lösenord som en del av kommentaren.

Nedan visas ett exempel på hur du gör det:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv.

Sidhuvuden och parametrar

Följande HTTP-sidhuvuden används i gränssnittet:

  • Cache-Control: max-age=<seconds>: Anger livstid för cachefrihet i sekunder. (Se RFC 7234.)
  • Prefer: respond-async: Anger att servern ska svara asynkront. (Se RFC 7240.)
  • Prefer: return=minimal: Anger att servern ska returnera ett minimalt svar. (Se RFC 7240.)

Följande HTTP-frågeparametrar är praktiska när det är svårt att använda HTTP-sidhuvuden:

  • max-age (tal, valfritt): Anger livstid för cachefrihet i sekunder. Siffran måste vara 0 eller större. Standardlivstiden för färskhet är 86400 sekunder. Utan den här parametern eller motsvarande rubrik används ett nytt cacheminne för att hantera begäranden i 24 timmar, och då måste cacheminnet genereras om. Använda max-age=0 kommer att tvinga cachen att rensas och initiera en omgenerering av rapporten med hjälp av den tidigare icke-nollvaraktigheten för det nyligen genererade cacheminnet.
  • respond-async (boolesk, valfritt): Anger att svaret ska anges asynkront. Använda respond-async=true när cacheminnet är inaktuellt returnerar servern ett svar på 202 Accepted utan att vänta på att cachen ska uppdateras och att rapporten ska genereras. Om cacheminnet är uppdaterat har den här parametern ingen effekt. Standardvärdet är false. Utan den här parametern eller motsvarande rubrik kommer servern att svara synkront, vilket kan kräva mycket tid och en justering av den maximala svarstiden för HTTP-klienten.
  • may-refresh-cache (boolesk, valfritt): Anger att servern kan uppdatera cachen som svar på en begäran om den aktuella cachen är tom, inaktuell eller snart inaktuell. If may-refresh-cache=true, eller om den inte anges, kan servern initiera en bakgrundsuppgift som anropar mönsteravkännaren och uppdaterar cachen. If may-refresh-cache=false kommer servern inte att initiera någon uppdateringsåtgärd som annars skulle ha gjorts om cachen är tom eller inaktuell, och då kommer rapporten att vara tom. Uppdateringsaktiviteter som redan pågår påverkas inte av den här parametern.
  • return-minimal (boolesk, valfritt): Anger att svaret från servern endast ska innehålla statusen som innehåller förloppsindikatorn och cachestatusen i JSON-formatet. If return-minimal=true, kommer svarstexten att begränsas till statusobjektet. If return-minimal=false, eller om det inte anges, kommer ett fullständigt svar att ges.
  • log-findings (boolesk, valfritt): Anger att servern ska logga innehållet i cachen när den skapas eller uppdateras för första gången. Varje sökning från cachen loggas som en JSON-sträng. Denna loggning sker endast om log-findings=true och begäran genererar ett nytt cacheminne.

När det finns både ett HTTP-sidhuvud och motsvarande frågeparameter har frågeparametern företräde.

Ett enkelt sätt att initiera rapportgenereringen via HTTP-gränssnittet är med följande kommando:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'.

När en begäran har skickats behöver klienten inte vara aktiv för att rapporten ska genereras. Rapportgenereringen kan initieras med en klient med en HTTP GET-begäran och när rapporten har genererats visas den från cachen med en annan klient eller med BPA-verktyget i AEM användargränssnitt.

Svar

Följande svarsvärden är möjliga:

  • 200 OK: Anger att svaret innehåller upptäckter från mönsteravkännaren som genererades under cachelagringens aktualitetstid.
  • 202 Accepted: Används för att ange att cachen är inaktuell. När respond-async=true och may-refresh-cache=true det här svaret anger att en uppdateringsaktivitet pågår. När may-refresh-cache=false det här svaret indikerar helt enkelt att cachen är inaktuell.
  • 400 Bad Request: Anger att det uppstod ett fel med begäran. Ett meddelande i formatet Probleminformation (se RFC 7807) innehåller mer information.
  • 401 Unauthorized: Anger att begäran inte var auktoriserad.
  • 500 Internal Server Error: Anger att ett internt serverfel uppstod. Ett meddelande i formatet Problem Details innehåller mer information.
  • 503 Service Unavailable: Anger att servern är upptagen med ett annat svar och inte kan hantera begäran i tid. Detta inträffar troligtvis bara när synkrona förfrågningar görs. Ett meddelande i formatet Problem Details innehåller mer information.

Administratörsinformation

Justera cacheminnets livslängd

Standardlivstiden för BPA-cache är 24 timmar. Med alternativet att uppdatera en rapport och återskapa cachen, både i AEM och HTTP-gränssnittet, är det här standardvärdet troligtvis lämpligt för de flesta användningsområden för BPA. Om rapportgenereringstiden är särskilt lång för AEM-instansen kanske du bör justera cachelivslängden för att minimera genereringen av rapporter.

Livslängdsvärdet för cacheminnet lagras som egenskapen maxCacheAge på följande databasnod:
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

Värdet för den här egenskapen är cachelivslängden i sekunder. Administratören kan justera cachelivslängden med CRX/DE Lite.

Installera på AEM 6.1

BPA använder ett användarkonto för systemtjänst med namnet repository-reader-service för att köra mönsteravkännaren. Det här kontot är tillgängligt på AEM 6.2 och senare. AEM 6.1 måste det här kontot skapas före installation av BPA enligt följande:

  1. Följ instruktionerna på Skapa en ny tjänstanvändare för att skapa en användare. Ange användar-ID till repository-reader-service och lämna den mellanliggande sökvägen tom. Klicka sedan på den gröna bockmarkeringen.

  2. Följ instruktionerna i Hantera användare och grupper. Särskilt instruktionerna för hur man lägger till användare i en grupp för att lägga till repository-reader-service-användaren i administrators-gruppen.

  3. Installera BPA-paketet via Package Manager på AEM. (Detta lägger till den nödvändiga konfigurationsändringen i konfigurationen ServiceUserMapper för repository-reader-service-systemtjänstanvändaren.)

På denna sida