Upgrading

Upgrading a site from SharePoint, Google Drive, or XWalk is a low complexity task. Despite being low in complexity, there are differences to know about and features to enable on the DA side.

High level things to know

  1. Protecting authoring - By default, your content is public. You will be prompted to secure your sandbox.

  2. Protecting publishing - By default, previewing and publishing is public. You can use tools.aem.live to turn on authentication for previewing and publishing.

  3. Live Preview - There is a small code snippet to add to scripts.js to enable DA's live preview.

  4. Live Preview - If you have an older project, your 404.html file may need a small change for live preview.

  5. Sidekick - If coming from XWalk, you may need to remove any legacy "edit" parameters in your Sidekick config.

  6. Assets - Turning on AEM Assets requires an AEMaaCS instance.

  7. Delivery HTML - DA & XWalk will have an extra paragraph tag when a list is nested inside another list. You can reach out to the Edge Delivery team to get this behavior changed using a feature flag.

  8. Delivery - There are several differences in media publishing support. You can see these on aem.live filed under limits.

  9. Query index / Sitemap - You no longer need to maintain a sheet for query indexes and sitemaps. These are now kept internal to Helix. You turn on your query indexes using a helix-query.yaml file (or in config bus yaml) YAML index docs.

    1. Note: Indexes that are not sheet based (ie. DA / XWalk / etc.) will be strongly typed. If you have code that expects strings for things like arrays, do know this difference.

  10. Configurations - DA has configs (settings icon in breadcrumb) and Edge Delivery has configs (config bus or .helix/config). They both have different use cases.

    1. DA Config - Used for DA permissions and DA feature flagging (UE, AEM Assets, etc.)
    2. Edge Delivery Config - Used for CDN info, preview and publish permissions, api keys, etc.

  11. Spreadsheets - DA's sheet editor is not meant to be an Excel replacement. It's good for about 5,000 rows (your mileage may vary). If you believe your project has complex sheet needs: conditional formatting, formulas, a lot of data, please use Edge Delivery's content overlay feature. More on this below.

  12. Spreadsheets - Helix cannot accept a named single sheet from DA. If you use named single sheets, we recommend adding another empty sheet or adjusting your code.

  13. Dot folders are hidden - Folders like /.helix , /.trash or /.da are hidden from the list view. You must enter these paths in using your browser's url bar. This is to reduce accidental changes to important configuration files.

Additional resources

  1. We have an end to end upgrade guide for business practitioners here: https://da.live/docs/administration/upgrade
  2. We have a guide on how to import content: https://github.com/adobe/da-live/wiki/Restore-from-aem
  3. We have a guide on setting up permissions: https://da.live/docs/administration/permissions

Live preview

Enable

The following code should be put at the bottom of your scripts.js file:

  • scripts.js (JavaScript)
(async function loadDa() {
  if (!new URL(window.location.href).searchParams.get('dapreview')) return;
  // eslint-disable-next-line import/no-unresolved
  import('https://da.live/scripts/dapreview.js').then(({ default: daPreview }) => daPreview(loadPage));
}());

This is an immediately-invoked function expression (IIFE) that will load dapreview.js if the dapreview query param is present.

Notes:

  1. It does not impact performance.
  2. It will load a CSS file to create a consistent experience (disable links).
  3. It creates bi-directional communication with DA.
  4. It will add a da-preview class to the body element in case you want to do live preview specific styling.

404.html

If you have an older project, you may need to adjust your 404.html file in your codebase to enable live preview.

Find

  • 404.html (markup)
<script src="/scripts/scripts.js" type="module" crossorigin="use-credentials"></script>

Replace

  • 404.html (markup)
<script src="/scripts/scripts.js" type="module"></script>

This is a legacy value that prevents external scripts from loading.

Identity

Protecting authored content

DA uses IMS top to bottom for identity. If you are a part of an organization, you are encouraged to use your org and groups to protect your content. If you do not have an organization, or prefer to use email addresses, you can also do so. The full docs are here: https://docs.da.live/administrators/guides/permissions

Content overlay

Below is the Config Bus content object you can use to overlay SharePoint / Google Drive with DA. This will allow you to seamlessly blend Excel sheets with your DA data.

  • Fstab (JSON)
"content": {
    "source": {
      "url": "https://adobe.sharepoint.com/:f:/r/sites/adobecom/DA%20Docs/da-bacom",
      "type": "onedrive"
    },
    "overlay": {
      "type": "markup",
      "url": "https://content.da.live/adobecom/da-bacom/"
    }
  }