使用最佳實踐分析器

使用最佳實踐分析器的重要注意事項

請依照以下章節瞭解執行最佳實務分析器(BPA)的重要考量事項：

• BPA報表是使用Adobe Experience Manager(AEM) Pattern Detector的輸出建立。 BPA使用的Pattern Detector版本包含在BPA安裝包中。

• BPA只能由​admin​用戶或​administrators​組中的用戶運行。

• BPA在6.1版及更高版本的AEM例項上受支援。

  注意

  如需在 AEM 6.1上安裝BPA的 特殊要求，請參閱「在AEM 6.1上安裝」。

• BPA可在任何環境上運行，但是最好在​Stage​環境上運行。

  注意

  為避免對業務關鍵型實例造成影響，建議您在自定義、配置、內容和用戶應用程式方面盡可能靠近 Production環境的 Authorenvironment上運行BPA。或者，您可以在複製的生產​製作​環境中執行 CRA。

• 生成BPA報告內容可能需要相當長的時間，從幾分鐘到幾小時。 所需的時間主要取決於 AEM 存放庫內容的大小和性質、AEM 版本和其他因素。

• 由於產生報表內容可能需要相當長的時間，因此這些內容會由背景程序產生，並儲存在快取中。檢視和下載報表的速度則相對迅速，因為此時會使用內容快取，直到快取過期或報表明確重新整理為止。在產生報表內容期間，您可以先關閉瀏覽器索引標籤，等稍後內容已存放於快取時，再回過頭檢視報表。

可用性

Best Practices Analyzer可從「軟體散發」入口網站下載為zip檔案。 您可以透過「封裝管理程式」，在來源 Adobe Experience Manager AEM) 例項上安裝封裝。

查看最佳實踐分析器報告

Adobe Experience Manager 6.3.0 和更新版本

請依照本節內容瞭解如何查看最佳實踐分析器報告：

1. 選擇Adobe Experience Manager並導覽至工具-> 操作 -> 最佳實務分析器。

   

2. 按一下​生成報告​以執行最佳實踐分析器。

   

3. 當BPA產生報表時，您可在螢幕上看到工具所做的進度。 它顯示分析的項目數，也顯示找到的發現數。

   

4. 生成BPA報告後，它以按查找類型和重要性級別組織的表格格式顯示摘要和查找結果數。 若要取得有關特定尋找的詳細資訊，您可以按一下表格中與尋找類型對應的數字。

   

   上述動作會自動捲動至報表中該尋找的位置。

   

5. 您可以選擇按一下​CSV，以逗號分隔值(CSV)格式下載報表，如下圖所示。

   

   注意

   您可以按一下「重新整理報表」，強制BPA清除其快取並重新產 生報表。

   

   注意

   在重新產生報表時，會以完成百分比顯示進度，如下圖所示。

   

Adobe Experience Manager 6.2 和 6.1

Adobe Experience Manager 6.2中的「最佳實務分析器」工具僅限於產生和下載CSV報表的連結。

在 Adobe Experience Manager 6.1 中，此工具無法運作，而只能使用 HTTP 介面。

解讀最佳實踐分析器報告

在AEM例項中執行「最佳實務分析器」工具時，報表會在工具視窗中顯示為結果。

報表格式為：

• 報表概覽：報表本身的相關資訊，包括下列資訊：
  • 報告時間：產生報表內容並首次提供的時間。
  • 到期時間：報表內容快取的到期時間。
  • 產生時段：報表內容產生程序所花費的時間。
  • 結果計數：報表中包含的結果總數。
• 系統概述:有關執行BPA的AEM系統的資訊。
• 結果類別：分別處理一或多個同類結果的多個區段。每個區段各包含下列項目：類別名稱、子類型、結果計數和重要性、摘要、類別文件的連結，以及個別結果資訊。

系統會為每個結果指派一個重要性層級，以指出動作的概略優先順序。

請參考下表以了解重要性層級：

解讀最佳實踐分析器CSV報告

當您從AEM例項按一下​CSV​選項時，「最佳實務分析器」報表的CSV格式會從內容快取建立，並傳回至您的瀏覽器。 根據您的瀏覽器設定，此報表將會以檔案格式自動下載，且具有預設名稱 results.csv。

如果快取已過期，則會在 CSV 檔案建置和下載之前重新產生報表。

CSV 格式的報表包含從「模式偵測器」輸出產生的資訊，且會依類別類型、子類型和重要性層級排序和組織。其格式適用於 Microsoft Excel 等應用程式的檢視和編輯作業。其目的是要以可重複的格式提供所有的結果資訊，以利進行長時間的報表比較，藉此衡量進度。

CSV 格式報表的欄包括：

• 代碼：類別代碼
• 類型：類別名稱
• 子類型：類別的子類型
• 重要性：重要性層級
• 識別碼：結果的主要識別碼
• 其他：關於結果的其他資訊
• 訊息：為結果提供的訊息
• 更多資訊：可用來存取類別相關線上說明的連結
• 內容：結果資料的 JSON 字串

個別結果的欄中若有 "\N" 值，表示未提供任何資料。

HTTP 介面

BPA提供HTTP介面，可用作AEM中使用者介面的替代選項。 該介面同時支援 HEAD 和 GET 命令。它可用於生成BPA報告並以三種格式之一返回：JSON、CSV和Tab分隔值(TSV)。

以下URL可用於HTTP訪問，其中<host>是安裝BPA的伺服器的主機名和埠（如果需要）:

• http://<host>/apps/best-practices-analyzer/analysis/report.json (JSON 格式)
• http://<host>/apps/best-practices-analyzer/analysis/report.csv (CSV 格式)
• http://<host>/apps/best-practices-analyzer/analysis/report.tsv (TSV 格式)

執行 HTTP 要求

HTTP 介面可用於多種方法中。

其中一個簡單的方式，是在您已用管理員身分登入 AEM 的相同瀏覽器中開啟瀏覽器索引標籤。您可以在瀏覽器索引標籤中輸入 URL，並且讓瀏覽器顯示或下載結果。

您也可以使用命令列工具 (例如 curl 或 wget) 以及任何 HTTP 用戶端應用程式。未在已驗證的工作階段中使用瀏覽器索引標籤時，您必須在註解中提供管理使用者名稱和密碼。

以下是其操作方式的範例：
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv。

標題和參數

此介面使用下列 HTTP 標題：

• Cache-Control: max-age=<seconds>:以秒為單位指定快取新鮮度存留期。(請參閱 RFC 7234。)
• Prefer: respond-async:指定伺服器應非同步響應。(請參閱 RFC 7240。)
• Prefer: return=minimal:指定伺服器應返回最小響應。(請參閱 RFC 7240。)

在不方便使用 HTTP 標題時，可權衡使用下列 HTTP 查詢參數：

• max-age （數字、可選）:以秒為單位指定快取新鮮度存留期。此數字必須大於或等於 0。預設新鮮度存留期為86400秒。 若沒有此參數或對應的標題，則會使用新的快取來提供24小時的請求，此時必須重新產生快取。 使用max-age=0將強制清除快取，並使用新產生的快取的先前非零新鮮度存留期，開始重新產生報表。
• respond-async （布林值，可選）:指定應非同步提供響應。當快取過時使用respond-async=true會導致伺服器傳回202 Accepted的回應，而不需等待快取重新整理及產生報表。 如果快取為最新狀態，此參數就沒有效用。預設值為false。如果沒有此參數或對應的標題，伺服器將同步響應，這可能需要相當長的時間，並需要調整HTTP客戶端的最大響應時間。
• may-refresh-cache （布林值，可選）:指定當當前快取為空、過時或即將過時時，伺服器可以響應請求刷新快取。如果may-refresh-cache=true或未指定，則伺服器可啟動後台任務，該任務將調用模式檢測器並刷新快取。 如果may-refresh-cache=false，則伺服器將不會啟動任何刷新任務，否則，如果快取為空或過時，伺服器將不會啟動任何刷新任務，在這種情況下，報告將為空。 任何已在處理中的刷新任務都將不受此參數的影響。
• return-minimal （布林值，可選）:指定來自伺服器的回應應僅包含包含進度指示和JSON格式快取狀態的狀態。如果return-minimal=true，則響應主體將限制為狀態對象。 如果return-minimal=false或未指定，則會提供完整的回應。
• log-findings （布林值，可選）:指定伺服器在首次構建或刷新快取時應記錄其內容。快取中的每個尋找都會記錄為JSON字串。 僅當log-findings=true請求生成新快取時，才會進行此記錄。

當 HTTP 標頭和對應的查詢參數均存在時，將會以查詢參數優先。

要透過 HTTP 介面開始產生報表，有個簡單的方式是使用下列命令：
curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.json?max-age=0&respond-async=true'。

在提出要求後，用戶端無須維持作用中狀態，即可產生報表。報表產生可以由一個用戶端使用HTTP GET請求啟動，報表產生後，就可透過另一個用戶端的快取或AEM使用者介面中的BPA工具從快取中檢視。

回應

可能的回應值如下：

• 200 OK:指出回應包含來自模式偵測器的發現，這些發現是在快取的新鮮期內產生的。
• 202 Accepted:用於指示快取過時。當respond-async=true和may-refresh-cache=true時，此響應表示正在執行刷新任務。 當may-refresh-cache=false時，此響應只表示快取過時。
• 400 Bad Request：表示要求發生錯誤。「問題詳細資訊」格式的消息（請參見RFC 7807）提供了詳細資訊。
• 401 Unauthorized:表示請求未獲得授權。
• 500 Internal Server Error：表示發生了內部伺服器錯誤。「問題詳細資料」格式的訊息可提供更多詳細資料。
• 503 Service Unavailable：表示伺服器正在處理另一個回應，而無法及時處理此要求。只有在提出同步要求時，才可能發生這種情況。「問題詳細資料」格式的訊息可提供更多詳細資料。

管理員資訊

快取存留期調整

預設的BPA快取存留期為24小時。 透過AEM例項和HTTP介面中重新整理報表和重新產生快取的選項，此預設值可能適用於BPA的大部分使用。 如果您 AEM 例項中的報表產生時間特別長，您可以調整快取存留期，以盡快重新產生報表。

快取存留期值會儲存為下列存放庫節點上的 maxCacheAge 屬性：
/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content

此屬性的值是快取存留期 (以秒為單位)。管理員可以使用 CRX/DE Lite 調整快取存留期。

在 AEM 6.1 上安裝

BPA利用名為repository-reader-service的系統服務用戶帳戶來執行模式檢測器。 此帳戶適用於 AEM 6.2 和更新版本。在AEM 6.1上，必須在​安裝BPA之前先建立此帳戶，方法如下：

1. 依照建立新的服務使用者中的指示建立使用者。將 UserID 設為 repository-reader-service，並將中繼路徑保留為空白，然後按一下綠色核取記號。

2. 依照管理使用者和群組中的指示 (尤其是「將使用者新增至群組」的指示)，將 repository-reader-service 使用者新增至 administrators 群組。

3. 透過Package Manager在您的來源AEM例項上安裝BPA套件。 (這將會在 repository-reader-service 系統服務使用者的 ServiceUserMapper 設定中新增必要的設定修正。)