DocumentationAEMAEM Screens Guide

Using Experience Fragments using-experience-fragments

Last update: Tue Apr 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Intermediate
  • Admin
  • Developer

This page covers the following topics:

  • Overview
  • Using Experience Fragments in AEM Screens
  • Propagating Changes to the Page

Overview overview

An Experience Fragment is a group of one or more components including content and layout that can be referenced within pages. Experience fragments can contain any component, such as one or multiple components that can contain anything within a paragraph system that is referenced into the complete experience or requested by a third endpoint.

Using Experience Fragments in AEM Screens using-experience-fragments-in-aem-screens

NOTE
The following example uses We.Retail as a demo project from where the Experience Fragment is applied from a Sites page to an AEM Screens project.

As an example, the following workflow demonstrates the use of experience fragments from We.Retail in Sites. You can choose a web page and use that content in your AEM Screens channel in one of your projects.

Pre-requisites pre-requisites

Creating a Demo Project with a Channel

Creating a Project

  1. To create a project, click Create Screens Project.
  2. Enter the Title as DemoProject.
  3. Click Save.

A DemoProject is added to your AEM Screens.

Creating a Channel

  1. Navigate to the DemoProject you created and click the Channels folder.

  2. Click Create from the action bar so you can open the wizard.

  3. Choose the Sequence Channel template from the wizard and click Next.

  4. Enter the Title as TestChannel and click Create.

A TestChannel is added to your DemoProject.
screen_shot_2019-07-29at105101am

Creating an Experience Fragment creating-an-experience-fragment

Follow the steps below to apply the content from We.Retail to your TestChannel in DemoProject.

  1. Navigate to a Sites page in We.Retail

    1. Navigate to Sites and click We.Retail > United States > English > Equipment and click this page so you can use this as an Experience Fragment for your Screens channel.

    2. Click Edit from the action bar so you can open the page you want to use as an Experience Fragment for your Screens channel.

  2. Reusing the Content

    1. Click the fragment that you want to include in your channel.
    2. Click the last icon from the right so you can open the Convert to Experience Fragment dialog box.

    screen_shot_2019-07-29at105314am

  3. Creating an Experience Fragment

    1. Choose the Action as Create a new Experience Fragment.

    2. Click the Parent path.

    3. Click the Template. Choose the Experience Fragment - Screens Variation template here (value in the field /libs/settings/screens/experience-fragments/templates/experience-fragment-template-screens).

    4. Enter the Fragment Title as ScreensFragment.

    5. To complete the creation of a new Experience Fragment, click the check mark.

    screen_shot_2019-07-29at105918am

    Note: To click an easier option, click the check mark to the right of the field so you can open the selection dialog box.

  4. Creating Live Copy of Experience Fragment

    1. Navigate to the AEM home page.
    2. Click Experience Fragments and highlight the ScreensFragment and click Variation as live-copy, as shown in the figure below:

    screen_shot_2019-07-29at110443am

    c. Click the ScreensFragment from Create Live Copy wizard and click Next.

    d. Enter the Title and Name as Screens.

    e. Click Create so you can create the Live Copy.

    f. Click Done so you can move back to ScreensFragment page.

    screen_shot_2019-07-29at110616am

    note note
    NOTE
    After you have created an AEM Screens fragment, you can edit the properties of your fragment. Click the fragment and click Properties from the action bar.

    Editing Properties of a Screens Fragment

    1. Navigate to the ScreensFragment (you created in the preceding steps) and click Properties from the action bar.

    2. Click the Offline Config tab, as shown in the figure below.

    You can add the Client-side Libraries (Java™ and css) and Static Files to your Experience Fragment.

    The following example shows the addition of client-side libraries and the fonts as a part of static files to your Experience Fragment. fragment

  5. Using Experience Fragment as a Component in Screens Channel

    1. Navigate to the Screens channel where you want to use the Screens fragment.

    2. Click the TestChannel and click Edit from the action bar.

    3. Click the components icon from the side tab.

    4. Drag and drop the Experience Fragment to your channel.

    screen_shot_2019-07-29at123115pm

    e. Click the Experience Fragment component and click the top left (wrench) icon so you can open the Experience Fragment dialog box.

    f. Click the Screens live copy of the fragment you created in Step 3 in Path.

    screen_shot_2019-07-26at82650pm

    f. Click the Screens live copy of the fragment you created in Step 3 in the Experience Fragment.

    screen_shot_2019-07-26at82509pm

    h. Enter the milliseconds in Duration.

    i. Click the Offline Config from the Experience Fragments dialog box so you can define the client-side libraries and the static files.

    note note
    NOTE
    To add client-side libraries, or the static files in addition to what you configured in step (4), you can add from the Offline Config tab in the Experience Fragment dialog box.

    screen_shot_2019-07-26at82844pm

    j. Click the check mark so you can complete the process.

Validating the Result validating-the-result

After completion of preceding steps, you can validate your Experience Fragment in ChannelOne by:

  1. Navigating to the TestChannel.
  2. Selecting the Preview from the action bar.

View the content from the Sites page (live-copy of the Experience Fragment) in your channel, as shown in the figure below:
screen_shot_2018-06-08at120739pm

Propagating Changes to the Page propagating-changes-from-the-master-page

Live Copy refers to the copy (of the source), maintained by synchronization actions as defined by the rollout configurations.

Because the Experience Fragment you created is a live copy from the Sites pages, and you change that particular fragment from the primary page, you view the changes in your channel. Or, view the destination where you have used the Experience Fragment.

NOTE
For more information on Live Copy, see Reusing Content: Multisite Manager and Live Copy.

Follow the steps below to propagate changes from the primary channel to your destination channel:

  1. Click the Experience Fragment from the Sites (primary) page and click the pencil icon so you can edit the items in the Experience Fragment.

    screen_shot_2018-06-08at122655pm

  2. Click the Experience Fragment and click the wrench icon so you can open the dialog box to edit the images.

    screen_shot_2018-06-08at25031pm

  3. The Product Grid dialog box opens.

    screen_shot_2018-06-08at25306pm

  4. You can edit any of the images. For example, here the first image is replaced in this fragment.

    screen_shot_2018-06-08at25608pm

  5. Click the Experience Fragment and click the Rollout icon so you can propagate changes to the fragment that is used in your channel.

    screen_shot_2018-06-08at31352pm

  6. Click Rollout.

    Notice that the changes are rolled out.

    screen_shot_2018-06-08at32148pm

Validating the Changes validating-the-changes

Follow the steps below to confirm the changes in your channel:

  1. Navigate to the Screens > Channels > TestChannel.

  2. Click Preview from the action bar.

The following image illustrates the changes in your TestChannel:
screen_shot_2018-06-08at33351pm

recommendation-more-help
adce462a-f916-4dbe-9ab5-0b62cfb0f053