使用最佳做法分析工具 using-best-practices-analyzer
使用Best Practices Analyzer的重要考量 imp-considerations
請參考以下章節，瞭解執行Best Practices Analyzer (BPA)時的重要考量：
-
BPA報告是使用Adobe Experience Manager (AEM) 模式偵測器的輸出所建置。 BPA使用的模式偵測器版本包含在BPA安裝封裝中。
-
BPA只能由 管理員 使用者或 管理員 群組中的使用者執行。
-
6.1版及更高版本的AEM執行個體支援BPA。
note note NOTE 如需在AEM 6.1上安裝BPA的特殊需求，請參閱在AEM 6.1上安裝。 -
BPA可以在任何環境中執行，但最好在 階段 環境中執行。
note note NOTE 為避免對業務關鍵執行個體造成影響，建議您在儘可能接近 生產 環境的 作者 環境中，對自訂、設定、內容和使用者應用程式等方面執行BPA。 或者，您可以在複製的生產 製作 環境中執行 CRA。 -
產生BPA報告內容可能需要相當長的時間，從幾分鐘到幾小時不等。 所需的時間主要取決於 AEM 存放庫內容的大小和性質、AEM 版本和其他因素。
-
由於產生報表內容可能需要相當長的時間，因此這些內容會由背景程序產生，並儲存在快取中。檢視和下載報表的速度則相對迅速，因為此時會使用內容快取，直到快取過期或報表明確重新整理為止。在產生報表內容期間，您可以先關閉瀏覽器索引標籤，等稍後內容已存放於快取時，再回過頭檢視報表。
可用性 availability
您可以從軟體發佈入口網站下載最佳做法分析工具的 ZIP 檔案。您可以在來源Adobe Experience Manager (AEM)執行個體上透過封裝管理員安裝封裝。
Source環境連線 source-environment-connectivity
來源AEM執行個體可能正在防火牆後面執行，而它只能連線至已新增至允許清單的特定主機。 若要將BPA產生的報告自動上傳至Cloud Acceleration Manager，下列端點必須可從執行AEM的執行個體存取：
- Azure Blob儲存服務：
casstorageprod.blob.core.windows.net
檢視Best Practices Analyzer報表 viewing-report
Adobe Experience Manager 6.3.0 和以上 aem-later-versions
請詳閱本節，瞭解如何檢視Best Practices Analyzer報告：
-
選取Adobe Experience Manager並導覽至工具> 作業 > 最佳做法分析工具。
-
按一下 產生報告 以執行Best Practices Analyzer。
-
提供BPA上傳金鑰以將產生的BPA報告自動上傳至Cloud Acceleration Manager (CAM)。 若要取得上傳金鑰，請瀏覽至CAM中的最佳實務分析
-
提供有效金鑰時，產生 按鈕會變成使用中。 按一下 產生 以開始產生報表。
-
在BPA產生報表時，您可以在畫面上看到工具執行的進度。 它以完成百分比顯示進度。 它也會顯示已分析的專案數，也會顯示找到的結果數。
-
產生BPA報告後，會以表格格式顯示結果的摘要和數目，並依據結果型別和重要性層級加以整理。 若要取得特定發現專案的詳細資訊，您可以按一下與表格中的發現專案型別相對應的數字。
-
您可以按一下 匯出至CSV，選擇下載逗號分隔值(CSV)格式的報表。 您也可以按一下 移至CAM，選擇在CAM中檢視報表。 這會帶您進入CAM中的最佳實務分析頁面。
您可以按一下 重新整理報告，以強制BPA清除其快取並重新產生報告。
- 如果快取過期，您可以選擇在CAM中檢視上次產生的報告，方法是按一下 在CAM中檢視上次產生的報告，或按一下 產生新報告 來啟動新的報告產生作業。
在Best Practices Analyzer報告中使用篩選器 bpa-filters
若要篩選出與ACS Commons相關的發現，請遵循下列步驟：
-
按一下頁面左側的左側欄圖示。 這會顯示 ACS Commons篩選器。 按一下 ACS Commons Filter 以顯示互動式核取方塊，如下圖所示。
note note NOTE 只有在BPA偵測到ACS Commons的使用時，左側邊欄圖示才會出現。 -
取消選取此方塊，以篩選掉與ACS Commons相關的所有發現。 您應該會在報表上看到 篩選的發現專案計數，如下圖所示。 當篩選器匯出為逗號分隔值(CSV)格式時，也會套用至報表。
note note NOTE 不應忽略ACS Commons的發現。 請參閱檔案以判斷與AEM as a Cloud Service的相容性。
最佳做法分析工具報告解讀 cra-report
在AEM例項中執行Best Practices Analyzer工具時，報表會在工具視窗中顯示為結果。
報表格式為：
-
報表概覽：報表本身的相關資訊，包括下列資訊：
- 報告時間：產生報表內容並首次提供的時間。
- 到期時間：報表內容快取的到期時間。
- 產生時段：報表內容產生程序所花費的時間。
- 結果計數：報表中包含的結果總數。
-
系統概覽：執行BPA之AEM系統的相關資訊。
-
結果類別：分別處理一或多個同類結果的多個區段。每個區段各包含下列項目：類別名稱、子類型、結果計數和重要性、摘要、類別文件的連結，以及個別結果資訊。
系統會為每個結果指派一個重要性層級，以指出動作的概略優先順序。
請參考下表以了解重要性層級：
解譯Best Practices Analyzer CSV報表 cra-csv-report
當您按一下AEM執行個體的 CSV 選項時，將會從內容快取建置CSV格式的Best Practices Analyzer報告，並傳回至您的瀏覽器。 根據您的瀏覽器設定，此報表會自動下載為預設名稱為results.csv的檔案。
如果快取已過期，則會在CSV檔案建置和下載之前重新產生報表。
CSV 格式的報表包含從「模式偵測器」輸出產生的資訊，且會依類別類型、子類型和重要性層級排序和組織。其格式適用於 Microsoft Excel 等應用程式的檢視和編輯作業。其目的是要以可重複的格式提供所有結果資訊，以利比較不同時間的報表，藉此衡量進度。
CSV 格式報表的欄包括：
- 代碼：類別代碼
- 類型：類別名稱
- 子類型：類別的子類型
- 重要性：重要性層級
- 識別碼：結果的主要識別碼
- 其他：關於結果的其他資訊
- 訊息：為結果提供的訊息
- 更多資訊：可用來存取類別相關線上說明的連結
- 內容：結果資料的 JSON 字串
個別結果的欄中若有 "\N" 值，表示未提供任何資料。
HTTP介面 http-interface
BPA提供HTTP介面，可作為AEM使用者介面的替代介面。 該介面同時支援 HEAD 和 GET 命令。它可用來產生BPA報表，並以三種格式之一傳回：JSON、CSV和定位鍵分隔值(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要求 executing-http-request
HTTP 介面可用於多種方法中。
其中一個簡單的方式，是在您已用管理員身分登入 AEM 的相同瀏覽器中開啟瀏覽器索引標籤。您可以在瀏覽器索引標籤中輸入 URL，並且讓瀏覽器顯示或下載結果。
您也可以使用命令列工具，例如curl或wget，以及任何HTTP使用者端應用程式。 未在已驗證的工作階段中使用瀏覽器索引標籤時，您必須在註解中提供管理使用者名稱和密碼。
以下是其操作方式的範例：curl -u admin:admin 'http://localhost:4502/apps/best-practices-analyzer/analysis/report.csv' > report.csv。
標題和引數 http-headers-and-parameters
此介面使用下列 HTTP 標題：
在不方便使用 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'。
在提出要求後，用戶端無須維持作用中狀態，即可產生報表。報表產生作業可以由一個使用者端使用HTTPGET要求來起始，且報表產生後，可由另一個使用者端從快取加以檢視，或透過AEM使用者介面中的BPA工具檢視。
回應 http-responses
可能的回應值如下：
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：表示伺服器正在處理另一個回應，而無法及時處理此要求。只有在提出同步要求時，才可能發生這種情況。「問題詳細資料」格式的訊息可提供更多詳細資料。
管理員資訊
快取存留期調整 cache-adjustment
預設的BPA快取存留期為24小時。 在AEM執行個體和HTTP介面中使用重新整理報告及重新產生快取的選項時，此預設值可能適用於BPA的大部分使用。 如果AEM例項中的報表產生時間特別長，您可以調整快取存留期以最小化報表的重新產生。
快取存留期值會儲存為下列存放庫節點上的 maxCacheAge 屬性：/apps/best-practices-analyzer/content/BestPracticesReport/jcr:content
此屬性的值是快取存留期 (以秒為單位)。管理員可以使用 CRX/DE Lite 調整快取存留期。
在AEM 6.1上安裝 installing-on-aem61
BPA使用名為repository-reader-service的系統服務使用者帳戶來執行模式偵測器。 此帳戶適用於 AEM 6.2 和更新版本。在AEM 6.1上，您必須執行下列步驟，在安裝BPA 之前 建立此帳戶：