netlify-aem-connector

AEM Connector for Netlify Connect

The AEM Connector for Netlify Connect is a Netlify Connect integration, developed and supported by VShift and Netlify, that enables Adobe Experience Manager (AEM) content to be used as a data and content source for Netlify Connect.

Connector Installation

1. Enable the Connector: Enable the “Adobe Experience Manager” connector via the Integrations library in your Netlify account dashboard or through the Netlify Integrations Hub.

2. Prepare and Configure AEM: Follow the steps listed below to configure your AEM instance for use with the connector.

3. Configure the Connector: Follow the steps listed in the Netlify Connect getting started documentation to configure the connector for your Netlify account. See below for a detailed explanation of the the specific AEM connector configuration options.

AEM Preparation and Configuration

To enable your AEM instance to effectively communicate and synchronize with Netlify Connect, perform the following steps.

1. Set Up Credentials: Configure service credentials in AEM to authenticate API requests from the connector following the instructions for setting up service credentials. Note that the credentials generated here will be used for configuring the AEM connector. For more information see below.

2. Create a GraphQL Endpoint: Create and configure a GraphQL endpoint in AEM to expose your content by following the steps provided in the Manage GraphQL endpoints in AEM documentation. Note that the GraphQL endpoint established here will be used for configuring the AEM connector. For more information see below.

3. Set Up Cloud Events: Enable automated sync of content updates to the connector whenever content changes occur in AEM by setting up Cloud Events. Navigate to Adobe Developer Console, create a new project, and follow the instructions for configuring events: Adobe Developer Console Guide. The documentation uses the example of Adobe XD, but select “AEM” under “Experience Cloud” instead.

Select your author instance on the next screen and then select which event types you’d like to subscribe to.

Select and name your credentials and event registration, and then select the “Webhook” option for listening to events.

The Webhook URL can be found under General Data Layer Settings on Netlify.

Once configured, Adobe will send a challenge request to the webhook. Follow the URL in the request body to validate the webhook. Adobe Challenge Request Guide

Connector Configuration

AEM API

AEM Query URL

• Description: AEM content fragment query endpoint.
• Example: https://author-xxxxxxx-xxxxxxxx.adobeaemcloud.com/content/_cq_graphql/[endpoint-name]/endpoint.json
• Notes: See step #2 in “AEM Preparation and Configuration” above. See the “PATH” column under Tools > General > GraphQL here.

AEM Credentials

• Description: AEM credentials JSON.
• Example:

   {
     "ok": true,
     "integration": {
       "imsEndpoint": "ims-na1.adobelogin.com",
       "metascopes": "ent_aem_cloud_api",
       "technicalAccount": {
         "clientId": "client-id",
         "clientSecret": "client-secret"
       },
       "email": "xxx-xxx-xxx-xxx-xxx@techacct.adobe.com",
       "id": "xxx@techacct.adobe.com",
       "org": "xxx@AdobeOrg",
       "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nprivate-key\n-----END CERTIFICATE-----\r\n",
       "certificateExpirationDate": "2025-01-01T00:00:00.000Z"
     },
     "statusCode": 200
   }
  

• Notes: See step #1 in “AEM Preparation and Configuration” above

Content Configuration

Project Names

• Description: An array of AEM project names that the connector should use for content and data synchronization. Webhook updates from any AEM projects not in this list will be ignored by the connector.
• Example: ["my-aem-project", "my-other-aem-project"]

Model Configuration

• Note: This option is optional, if you do not provide this, all models and references to those models will be synced.
• Description: Configuration for models in AEM to be synced. This configuration includes the names of the models, the corresponding content fragment reference fields, and experience fragment fields. If a model has no reference fields or experience fragment fields, its name can be passed as a stand-alone string instead of as part of an object.
• Example:

  [
    {
      "name": "ArticleModel",
      "referenceFields": [
        "relatedArticles",
        "author"
      ],
      "experienceFragmentFields": [
        "bodyXfContent"
      ]
    },
    "AwardModel",
    {
      "name": "CollectionModel",
      "referenceFields": [
        "items"
      ]
    }
  ]
  

• Notes:
  • Reference fields identify fields that are references to other content fragment instances. These fields must be explicitly identified for all synchronized content fragment models.
  • Experience fragment fields: identify fields that point to experience fragments.

Advanced

Model Sync Concurrency

• Description: Specifies the maximum number of content fragment model types the connector will process concurrently when synchronizing data. Can be adjusted to optimize performance.
• Default: 10

Maximum Update Frequency

• Description: Specifies the maximum frequency / minimum time interval, in milliseconds, for connector content synchronization. Configurable to manage load versus data update delay.
• Default: 30000

Include Metadata

• Description: Indicates whether to retrieve built-in metadata fields from AEM.
• Default: false

Enable Debug Webhook

• Description: Indicates whether to log the webhook body to the Netlify Connect terminal.
• Default: false

Post-Installation

With the Configuration Options set and AEM properly configured, your Netlify Connect AEM Connector is ready to synchronize content to your Netlify Connect data layer. Test the connection thoroughly to ensure data flows correctly between AEM and Netlify without issues.