Support and Documentation

Adobe Experience Manager

With the Adobe Experience Manager (AEM) plugin, you can synchronize content between Brightspot and AEM.

Understanding the Brightspot-AEM synchronization

The synchronization between Brightspot and AEM is bi-directional: items you create or modify in Brightspot are exported to AEM, and items you create or modify in AEM are imported into Brightspot.

For items created in Brightspot, the synchronization is at the content-type level: if you configure the synchronization for articles, all articles are synchronized, and if you configure the synchronization for images, all images are synchronized.

For items created in AEM, the synchronization applies to a folder you choose. If you configure synchronization for a folder in AEM named myassets, the synchronization occurs between assets in that AEM folder and that are of the appropriate content type.

When you create an item in Brightspot, the synchronization creates a parallel item in AEM. To create that parallel item, Brightspot does the following:

  1. Retrieves the name of the AEM synchronization folder.

  2. In AEM, under the synchronization folder, creates a new subfolder that represents the current date.

  3. Creates the item inside the AEM folder.

  4. Retrieves the UUID AEM assigns to the item.

For example, your synchronization folder in AEM is myassets, and you create a new image in Brightspot on October 15, 2021. Brightspot creates a new AEM folder myassets/2021/10/15, places the image in that folder, and retrieves the UUID that AEM assigned to that item. You can view the folder and UUID in the content edit form's AEM tab.

aem-tab.svg

Contact your Brightspot representative to add additional content types or other customizations for the synchronization. For example, you can limit the customization to a particular editor, role, or site.

Configuring AEM synchronization

Administrators perform this task.

If your version of Brightspot is missing this feature, contact your Brightspot representative.​

Procedure. To configure AEM synchronization:
  1. In AEM, create the folder you want to synchronize with Brightspot.

  2. To configure synchronization from Brightspot to AEM, do the following:

    1. From the Navigation Menu, expand Admin, and select Sites & Settings.

    2. In the Sites widget, select Global. The Edit Global widget appears.

    3. Under Main, expand Adobe AEM.

    4. From the Settings list, select Set.

    5. Using the following table as a reference, enter values to synchronize content from Brightspot to AEM.

    6. Click Save.

  3. To configure synchronization from AEM to Brightspot, do the following:

    1. Go to the AEM tools console at http://<aehmost>/miscadmin.

    2. Under Tools/Replication, select Agents on author.

    3. Click New. A Create Page dialog box appears.

    4. In the Title field, enter the synchronization folder's title. See the illustration AEM folder and title.

    5. In the Name field, enter the synchronization folder's name.

    6. Select Replication Agent.

    7. Click Create. You return to the Agents on author list.

    8. Double-click the agent you just created. A widget appears.

    9. Click Edit. An Agent Settings dialog box appears.

    10. Under Transport, in the URI field, enter http://hostname/_api/adobe/aem, where hostname is the Brightspot tool URL, such as http://editors.mybrightspot.com/.

    11. In the User and Password fields, enter an existing Brightspot username and password. Ensure this user has adequate permissions to create content.

    12. Under Triggers, mark On Modification.

    13. Click OK. You return to the previous widget.

    14. Click Test Connection. A web page appears with diagnostic messages. If the last message is Replication test succeeded, the AEM-to-Brightspot synchronization is configured correctly.

The following table describes the fields for configuring the Brightspot-to-AEM synchronization.

Field

Description

AEM Base URL

Top-level URL for logging on to AEM, such as http://myaem.myhost.com. Do not include a trailing slash.

AEM Repository URL

URL to the AEM repository. This URL is typically the AEM base URL and a path, such as http://myaem.myhost.com/crx/server. Do not include a trailing slash. You can find the path by doing the following:

  1. Go to the URL http://myaem.myhost.com/system/console/components. The Adobe Experience Manager Web Console appears.

  2. Expand the component org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet.

  3. Under Properties, look at the value for alias.

    aem-repository-path.png

AEM Username

Username for logging in to AEM.

AEM Password

Password for logging in to AEM.

Jcr Workspace

AEM Java Content Repository. You can determine the available repositories by doing the following:

  1. Open the CRX DE by going to the URL http://myaem.myhost.com/crx/de/index.jsp.

  2. Expand /etc/virtual-repositories, and select the required JCR.

  3. Use the value for address.

aem-jcr-workspace.svg

The default workspace is typically crx.default.

Aem Dam Root

Path to the root folder where AEM stores your assets. You can determine the AEM DAM root by examining the URL of a folder. For example, if a folder's name is my-images, and URL to the folder is http://myaem.myhost.com/content/dam/geometrixx-outdoors, then the AEM DAM root is content/dam. Do not include a trailing slash.

Aem Image Folder

Name of existing folder in AEM. You can view a folder's name and title by doing the following:

  1. Open the CRX DE by going to the URL http://myaem.myhost.com/crx/de/index.jsp.

  2. In the CRX DE search bar, search for the folder's name or title.

  3. In the Aem Image Folder field, enter one of the folder names, typically under the key /content/dam/.

AEM folder and title
Figure 150. AEM folder and title


Aem Image Folder Title

Title of existing folder in AEM. See the illustration AEM folder and title.

Brightspot CMS Base URL

Brightspot tool URL, such as http://editors.mybrightspot.com/.

Disable Import

  • If toggled on, items you create in AEM are not imported into Brightspot.

  • If toggled off, items you create in AEM are imported into Brightspot.

Disable Export

  • If toggled on, items you create in Brightspot are not exported to AEM.

  • If toggled off, items you create in Brightspot are exported to AEM.

Aem Node Initializer

Initialization setting to use this integration. For most implementations, select Aem Node Default Initializer. For other settings, contact your Brightspot representative.

Finding and modifying synchronized items in AEM

If you created a synchronized item in Brightspot, you can open and modify the same item in AEM.

Note

The procedure in this section applies to content types and fields configured for synchronization between Brightspot and AEM. If you need synchronization for additional content types or fields, contact your Brightspot representative.

Procedure. To find and modify a synchronized item in AEM:
  1. In Brightspot, open the item in the content edit form.

  2. Toward the right of the form, select |mi-more_horiz|> AEM. A widget appears.

    aem-tab.svg
  3. In AEM, do one of the following:

    • Paste the item's title into the search field.

    • Paste the item's UUID into the search field.

    • Navigate to the item using the AEM path.

  4. Modify the item in AEM, and save the changes. The changes appear in Brightspot.

Finding and modifying synchronized items in Brightspot

If you created a synchronized item in AEM, you can open and modify the same item in Brightspot.

Note

The procedure in this section applies to content types and fields configured for synchronization between Brightspot and AEM. If you need synchronization for additional content types or fields, contact your Brightspot representative.

Procedure. To find and modify a synchronized item in Brightspot:
  1. Open the item in AEM, and observe the item's UUID and title.

    aem-item-uuid-title.svg
  2. In Brightspot, do one of the following:

    • Paste the item's title into the search field.

    • Paste the item's UUID into the search field.

  3. Modify the item in Brightspot, and save the changes. The changes appear in AEM.