Uso del Analizador de prácticas recomendadas

Consideraciones importantes sobre el uso de Best Practices Analyzer

Siga la sección siguiente para comprender las consideraciones importantes para ejecutar el Analizador de prácticas recomendadas (BPA):

  • El informe de BPA se crea con la salida de Adobe Experience Manager (AEM) Pattern Detector. La versión de Pattern Detector utilizada por BPA se incluye en el paquete de instalación de BPA.

  • Solo puede ejecutar BPA el usuario admin o un usuario del grupo administradores.

  • BPA se admite en instancias AEM con la versión 6.1 o posterior.

    NOTA

    Consulte Instalar en AEM 6.1 para conocer los requisitos especiales para instalar BPA en AEM 6.1.

  • BPA puede ejecutarse en cualquier entorno, pero se prefiere que se ejecute en un entorno Stage.

    NOTA

    Para evitar un impacto en las instancias críticas para el negocio, se recomienda ejecutar BPA en un entorno de **autorización lo más cercano posible al entorno de ** producción en las áreas de personalizaciones, configuraciones, contenido y aplicaciones de usuario. Como alternativa, se puede ejecutar en un clon del entorno de Author de producción.

  • La generación del contenido de los informes de BPA puede llevar una cantidad de tiempo considerable, de varios minutos a pocas horas. La cantidad de tiempo necesaria depende en gran medida del tamaño y la naturaleza del contenido del repositorio de AEM, la versión de AEM y otros factores.

  • Debido al tiempo considerable que puede ser necesario para generar el contenido del informe, se generan mediante un proceso en segundo plano y se guardan en la caché. Ver y descargar el informe debería ser relativamente rápido, ya que utiliza la caché de contenido hasta que caduque o hasta que el informe se actualice de forma explícita. Durante la generación del contenido del informe, puede cerrar la pestaña del explorador y regresar más tarde para ver el informe una vez que su contenido esté disponible en la caché.

Disponibilidad

El Analizador de prácticas recomendadas se puede descargar como archivo zip desde el portal de distribución de software. Puede instalar el paquete mediante el Administrador de paquetes en la instancia de origen de Adobe Experience Manager (AEM).

NOTA

Descargue el Analizador de prácticas recomendadas del portal de distribución de software.

Visualización del informe de Best Practices Analyzer

Adobe Experience Manager 6.3.0 y versiones posteriores

Siga esta sección para obtener información sobre cómo ver el informe del Analizador de prácticas recomendadas:

  1. Seleccione Adobe Experience Manager y vaya a las herramientas -> Operaciones -> Analizador de prácticas recomendadas.

    image

  2. Haga clic en Generar informe para ejecutar el Analizador de prácticas recomendadas.

    image

  3. Mientras el BPA está generando el informe, puede ver el progreso realizado por la herramienta en la pantalla. Muestra el número de elementos analizados y también el número de resultados encontrados.

    image

  4. Una vez generado el informe de BPA, muestra un resumen y el número de conclusiones en un formato de tabla organizado por el tipo de búsqueda y el nivel de importancia. Para obtener más información sobre una búsqueda en particular, puede hacer clic en el número que corresponde al tipo de búsqueda en la tabla.

    image

    La acción anterior se desplazará automáticamente a la ubicación de esa búsqueda en el informe.

    image

  5. Tiene la opción de descargar el informe en formato de valores separados por comas (CSV) haciendo clic en Exportar a CSV, como se muestra en la figura siguiente.

    image

    NOTA

    Puede forzar el BPA para que borre su caché y vuelva a generar el informe haciendo clic en Actualizar informe.

    image

    NOTA

    Mientras el informe se está regenerando, muestra el progreso en términos de porcentaje completado como se muestra en la imagen siguiente.

    image

Uso de filtros en el informe de Best Practices Analyzer

Para filtrar los resultados relacionados con ACS Commons, siga los pasos a continuación:

  1. Haga clic en el icono del carril izquierdo en el lado izquierdo de la página. Se mostrará el ACS Commons Filter. Haga clic en ACS Commons Filter para mostrar la casilla interactiva como se muestra en la imagen siguiente.

    image

    NOTA

    El icono del carril izquierdo aparecerá únicamente si el BPA detecta el uso de ACS Commons.

  2. Desmarque la casilla para filtrar todos los hallazgos relacionados con ACS Commons. Debería ver un Recuento de búsqueda filtrado en el informe como se muestra en la imagen siguiente. El filtro también se aplica al informe cuando se exporta en formato CSV (valores separados por comas).

    image

    NOTA

    Los hallazgos de ACS Commons no deben ser ignorados. Consulte la documentación para determinar la compatibilidad con AEM as a Cloud Service.

Adobe Experience Manager 6.2 y 6.1

La herramienta Analizador de prácticas recomendadas está limitada en Adobe Experience Manager 6.2 a un vínculo que genera y descarga el informe CSV.

Para Adobe Experience Manager 6.1, la herramienta no funciona y solo se puede utilizar la interfaz HTTP.

NOTA

En todas las versiones, Pattern Detector puede ejecutarse de forma independiente.

Interpretación del informe de Best Practices Analyzer

Cuando la herramienta Analizador de prácticas recomendadas se ejecuta en la instancia de AEM, el informe se muestra como resultados en la ventana de herramientas.

El formato del informe es el siguiente:

  • Información general del informe: información sobre el informe que incluye lo siguiente:
    • Hora del informe: el horario en que se generó el contenido del informe y se puso a disposición por primera vez.
    • Hora de caducidad: cuando caduque la caché de contenido del informe.
    • Período de tiempo de generación: tiempo empleado por el proceso de generación de contenido del informe.
    • Recuento de búsqueda: número total de conclusiones incluidas en el informe.
  • Información general del sistema: Información sobre el sistema AEM en el que se ejecutó el BPA.
  • Búsqueda de categorías: varias secciones en las que cada una de ellas aborda uno o más resultados de la misma categoría. Cada sección incluye lo siguiente: nombre de la categoría, subtipos, número de búsquedas e importancia, resumen, vínculo a la documentación de la categoría e información de búsqueda individual.

Se asigna un nivel de importancia a cada resultado para indicar una prioridad aproximada para la acción.

NOTA

Para obtener más información sobre cada categoría de búsqueda, consulte Categorías de detector de patrones.

Siga la tabla siguiente para comprender los niveles de importancia:

Importancia Descripción
INFORMACIÓN Esta conclusión se proporciona con fines informativos.
CONSEJO Este resultado es potencialmente un problema de actualización. Se recomienda una investigación más a fondo.
PRINCIPAL Es probable que este resultado sea un problema de actualización que se deba abordar.
CRÍTICO Es muy probable que este hallazgo sea un problema de actualización que debe solucionarse para evitar la pérdida de funciones o rendimiento.

Interpretación del informe CSV de Best Practices Analyzer

Al hacer clic en la opción CSV desde la instancia de AEM, el formato CSV del informe del Analizador de prácticas recomendadas se crea desde la caché de contenido y se devuelve al explorador. Según la configuración del explorador, este informe se descargará automáticamente como archivo con un nombre predeterminado de results.csv.

Si la caché ha caducado, el informe se regenerará antes de crear y descargar el archivo CSV.

El formato CSV del informe incluye información que se genera a partir de los resultados de Pattern Detector, ordenados y organizados por tipo de categoría, subtipo y nivel de importancia. Su formato es adecuado para visualizarlo y editarlo en una aplicación como Microsoft Excel. Su finalidad es proporcionar toda la información de búsqueda en un formato repetible que pueda resultar útil al comparar los informes con el paso del tiempo para medir el progreso.

Las columnas del informe de formato CSV son las siguientes:

  • Código: el código de categoría.
  • Tipo: el nombre de la categoría.
  • Subtipo: subtipo de categoría.
  • Importancia: el nivel de importancia.
  • Identificador: el identificador principal de la búsqueda.
  • Otros: información adicional sobre la búsqueda.
  • Mensaje: el mensaje proporcionado para la búsqueda.
  • MoreInfo: un vínculo que puede utilizarse para acceder a la ayuda en línea sobre la categoría.
  • Contexto: una cadena JSON de búsqueda de datos.

El valor "\N" en una columna para una búsqueda individual indica que no se proporcionaron datos.

Interfaz HTTP

El BPA proporciona una interfaz HTTP que puede utilizarse como alternativa a su interfaz de usuario en AEM. La interfaz admite comandos HEAD y GET. Puede utilizarse para generar el informe de BPA y devolverlo en uno de los tres formatos siguientes: JSON, CSV y valores separados por tabuladores (TSV).

Las siguientes direcciones URL están disponibles para el acceso HTTP, donde <host> es el nombre de host y el puerto, si es necesario, del servidor en el que está instalado el BPA:

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

Ejecución de una petición HTTP

La interfaz HTTP puede utilizarse en diversos métodos.

Una forma sencilla es abrir una pestaña en el mismo explorador en el que ya ha iniciado sesión en AEM como administrador. Puede escribir la dirección URL en la pestaña del explorador y mostrar o descargar los resultados.

También puede utilizar una herramienta de línea de comandos como curl o wget como así también cualquier aplicación cliente HTTP. Cuando no utilice una pestaña de explorador con una sesión autenticada, debe proporcionar el nombre de usuario y la contraseña de administración como parte del comentario.

A continuación se muestra un ejemplo de cómo se puede realizar esto:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv.

Encabezados y parámetros

Esta interfaz utiliza los siguientes encabezados HTTP:

  • Cache-Control: max-age=<seconds>: Especifica la duración de la actualización de la caché en segundos. (Consulte RFC 7234.)
  • Prefer: respond-async: Especifica que el servidor debe responder asincrónicamente. (Consulte RFC 7240).
  • Prefer: return=minimal: Especifica que el servidor debe devolver una respuesta mínima. (Consulte RFC 7240).

Los siguientes parámetros de consulta HTTP están disponibles para determinar cuándo es posible que los encabezados HTTP no se utilicen fácilmente:

  • max-age (número, opcional): Especifica la duración de la actualización de la caché en segundos. Este número debe ser 0 o más. La duración de la actualización predeterminada es de 86 400 segundos. Sin este parámetro o el encabezado correspondiente, se utilizará una nueva caché para servir solicitudes durante 24 horas, momento en el cual se debe volver a generar la caché. El uso de max-age=0 fuerza a que se borre la caché e inicia una regeneración del informe, usando la duración de la actualización no nula anterior para la caché recién generada.
  • respond-async (booleano, opcional): Especifica que la respuesta se debe proporcionar de forma asíncrona. Si utiliza respond-async=true cuando la caché está obsoleta, el servidor devolverá una respuesta de 202 Accepted sin esperar a que se actualice la caché y se genere el informe. Si la caché es nueva, este parámetro no tiene ningún efecto. El valor predeterminado es false. Sin este parámetro o el encabezado correspondiente, el servidor responderá sincrónicamente, lo que puede requerir una cantidad de tiempo considerable y un ajuste del tiempo de respuesta máximo para el cliente HTTP.
  • may-refresh-cache (booleano, opcional): Especifica que el servidor puede actualizar la caché en respuesta a una solicitud si la caché actual está vacía, obsoleta o pronto estará obsoleta. Si may-refresh-cache=true, o si no se especifica, el servidor puede iniciar una tarea en segundo plano que invoque Pattern Detector y actualice la caché. Si may-refresh-cache=false, el servidor no iniciará ninguna tarea de actualización que de otra manera se hubiera realizado si la caché está vacía o obsoleta, en cuyo caso el informe estará vacío. Cualquier tarea de actualización que ya esté en proceso no se verá afectada por este parámetro.
  • return-minimal (booleano, opcional): Especifica que la respuesta del servidor solo debe incluir el estado que contiene la indicación de progreso y el estado de caché en el formato JSON. Si es return-minimal=true, el cuerpo de respuesta se limitará al objeto de estado. Si return-minimal=false, o si no se especifica, se proporcionará una respuesta completa.
  • log-findings (booleano, opcional): Especifica que el servidor debe registrar el contenido de la caché cuando se crea o actualiza por primera vez. Cada búsqueda de la caché se registrará como una cadena JSON. Este registro solo se producirá si log-findings=true y la solicitud genera una nueva caché.

Cuando están presentes tanto un encabezado HTTP como el parámetro de consulta correspondiente, el parámetro de consulta tendrá prioridad.

Una manera sencilla de iniciar la generación del informe a través de la interfaz HTTP es con el siguiente comando:
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'.

Una vez realizada una solicitud, el cliente no necesita permanecer activo para que se genere el informe. La generación de informes se puede iniciar con un cliente mediante una solicitud de GET HTTP y, una vez generado el informe, se puede ver desde la caché con otro cliente o con la herramienta BPA en la interfaz de usuario de AEM.

Respuestas

Los siguientes valores de respuesta son posibles:

  • 200 OK: Indica que la respuesta contiene los resultados del detector de patrones que se generaron durante la duración de la actualización de la caché.
  • 202 Accepted: Se utiliza para indicar que la caché está obsoleta. Cuando respond-async=true y may-refresh-cache=true esta respuesta indica que se está realizando una tarea de actualización. Cuando may-refresh-cache=false esta respuesta simplemente indica que la caché está obsoleta.
  • 400 Bad Request: indica que se produjo un error con la solicitud. Un mensaje en formato Detalles del problema (consulte RFC 7807) proporciona más detalles.
  • 401 Unauthorized: Indica que la solicitud no está autorizada.
  • 500 Internal Server Error: indica que se ha producido un error de servidor interno. El mensaje en formato Detalles del problema proporciona más detalles.
  • 503 Service Unavailable: indica que el servidor está ocupado con otra respuesta y no puede atender esta solicitud de forma oportuna. Esto solo es probable cuando se realizan solicitudes sincrónicas. El mensaje en formato Detalles del problema proporciona más detalles.

Información del administrador

Ajuste de la duración de caché

La duración predeterminada de la caché de BPA es de 24 horas. Con la opción para actualizar un informe y regenerar la caché, tanto en la instancia de AEM como en la interfaz HTTP, es probable que este valor predeterminado sea adecuado para la mayoría de los usos del BPA. Si el tiempo de generación de informes es particularmente largo para la instancia de AEM, puede que desee ajustar la duración de la caché para minimizar la regeneración del informe.

El valor de duración de la caché se almacena como la maxCacheAge propiedad en el siguiente nodo de repositorio:
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

El valor de esta propiedad es la duración de la caché en segundos. Un administrador puede ajustar la duración de la caché mediante CRX/DE Lite.

Instalar en AEM 6.1

BPA utiliza una cuenta de usuario de servicio del sistema denominada repository-reader-service para ejecutar Pattern Detector. Esta cuenta está disponible en AEM 6.2 y posteriores. En AEM 6.1, esta cuenta debe crearse antes de la instalación de BPA siguiendo los pasos siguientes:

  1. Siga las instrucciones en Crear un nuevo usuario de servicio para crear un usuario. Establezca el UserID en repository-reader-service y deje la ruta intermedia vacía y luego haga clic en la marca de verificación verde.

  2. Siga las instrucciones en Administrar usuarios y grupos, específicamente las instrucciones para Añadir usuarios a un grupo para agregar el repository-reader-service usuario al administrators grupo.

  3. Instale el paquete BPA mediante el Administrador de paquetes en la instancia de AEM de origen. (Esto agregará la modificación de configuración necesaria a la configuración de ServiceUserMapper para el usuario del servicio repository-reader-service del sistema).

En esta página