Preflight setup

To set up Preflight in Universal Editor, follow these steps:

1. Open the Extension Manager at:
   https://experience.adobe.com/#/@org/aem/extension-manager/universal-editor

2. Locate the AEM Sites Optimizer Preflight Extension and submit a request to enable it.

3. The Adobe AEM team reviews and enables the extension for your organization.

4. After the extension is enabled, open a page in Universal Editor, for example:
   https://author-p12345-e123456.adobeaemcloud.com/ui#/@org/aem/universal-editor/canvas/author-p12345-e123456.adobeaemcloud.com/content/en/example/home.html

5. The Preflight Extension appears in the side rail.

6. Select the Preflight Extension from the side rail to start a Preflight Audit of the current page.

To set up Preflight for Document-based authoring, follow these steps:

1. Add the following configuration to /tools/sidekick/config.json in your Edge Delivery Services project’s GitHub repository:

   code language-json
   { "plugins": [ { "id": "preflight", "titleI18n": { "en": "Preflight" }, "environments": ["preview"], "event": "preflight" } ] }

2. Create a new file /tools/sidekick/aem-sites-optimizer-preflight.js and add the following content:

   code language-javascript

   (function () { let isAEMSitesOptimizerPreflightAppLoaded = false; function loadAEMSitesOptimizerPreflightApp() { const script = document.createElement('script'); script.src = 'https://experience.adobe.com/solutions/OneAdobe-aem-sites-optimizer-preflight-mfe/static-assets/resources/sidekick/client.js?source=plugin'; script.onload = function () { isAEMSitesOptimizerPreflightAppLoaded = true; }; script.onerror = function () { console.error('Error loading AEMSitesOptimizerPreflightApp.'); }; document.head.appendChild(script); } function handlePluginButtonClick() { if (!isAEMSitesOptimizerPreflightAppLoaded) { loadAEMSitesOptimizerPreflightApp(); } } // Sidekick V1 extension support const sidekick = document.querySelector('helix-sidekick'); if (sidekick) { sidekick.addEventListener('custom:preflight', handlePluginButtonClick); } else { document.addEventListener('sidekick-ready', () => { document.querySelector('helix-sidekick') .addEventListener('custom:preflight', handlePluginButtonClick); }, { once: true }); } // Sidekick V2 extension support const sidekickV2 = document.querySelector('aem-sidekick'); if (sidekickV2) { sidekickV2.addEventListener('custom:preflight', handlePluginButtonClick); } else { document.addEventListener('sidekick-ready', () => { document.querySelector('aem-sidekick') .addEventListener('custom:preflight', handlePluginButtonClick); }, { once: true }); } }());

3. Update the loadLazy() function in /scripts/scripts.js to import the Preflight script for preview URLs:

   code language-javascript
   if (window.location.href.includes('.aem.page')) { import('../tools/sidekick/aem-sites-optimizer-preflight.js'); }

4. Open the preview URL (*.aem.page) of the page that you want to audit.

5. In Sidekick, click the Preflight button to start the audit for the current page.

To use Preflight in the AEM Sites Page Editor, you can create a bookmarklet in your web browser. Follow these steps:

1. Show your Bookmarks Bar in your Web browser:

   • Press Ctrl+Shift+B (Windows) or Cmd+Shift+B (Mac).

2. Create a new bookmark in your browser:

   • Right-click the Bookmarks Bar and select New Page or Add Bookmark.
   • In the Address (URL) field, paste the following code:

   code language-javascript
   javascript:(function(){const script=document.createElement('script');script.src='https://experience.adobe.com/solutions/OneAdobe-aem-sites-optimizer-preflight-mfe/static-assets/resources/sidekick/client.js?source=bookmarklet&target-source=aem-cloud-service';document.head.appendChild(script);})();

3. Name the bookmark Preflight (or any name you prefer).

4. Open the preview URL (*.aem.page) of the page that you want to audit in the AEM Sites Page Editor.

5. Click the Preflight bookmark in your Bookmarks Bar to start the audit for the current page.

To use Preflight in the AEM Sites Page Editor on an AMS environment, create a bookmarklet in your web browser, following these steeps:

1. Show your Bookmarks Bar in your web browser:

   • Press Ctrl+Shift+B (Windows) or Cmd+Shift+B (Mac).

2. Create a new bookmark in your browser:

   • Right-click the Bookmarks Bar and select New Page or Add Bookmark.
   • In the Address (URL) field, paste the following code:

   code language-javascript
   javascript:(function(){const script=document.createElement('script');script.src='https://experience.adobe.com/solutions/OneAdobe-aem-sites-optimizer-preflight-mfe/static-assets/resources/sidekick/client.js?source=bookmarklet&target-source=ams';document.head.appendChild(script);})();

3. Name the bookmark Preflight (or any name you prefer).

4. Open the page you want to audit in the AEM Sites Page Editor.

5. Click the Preflight bookmark in your Bookmarks Bar to start the audit for the current page.