Skip to content

Latest commit

 

History

History
96 lines (77 loc) · 4.22 KB

README.md

File metadata and controls

96 lines (77 loc) · 4.22 KB
Raw

Adobe Assets Selector Extension Configuration

This repository contains a sample configuration that is hosted by the App Builder platform to extend the Assets Selector. It generates configuration on-the-fly based on the context provided, allowing various Assets Selector extensions. The configuration can be context-aware or context-agnostic depending on the provided parameters.

Overview

The hosted configuration serves as an example of how to host an extension config to extend the functionality of the Assets Selector. It enables dynamic generation of configurations, which can be customized based on the Web Page's path.

Key Features:

  • Dynamic Configuration: Generate configuration at runtime based on the web path provided.
  • Contextual Extensions: Match specific tags based on the web path or URL pattern and apply them as default tags to extend the Assets Selector functionality.
  • Context-Agnostic: The config can also work without any web path, providing a generic set of configurations.

Parameters

The following parameters are accepted by the extension configuration:

1. webPath (optional)

  • Description: This is the path of the web page for which the configuration is invoked. For a detailed explanation, refer to the Adobe Experience Manager (AEM) documentation.
  • Usage: Assets Selector can generate an extension config in the context of a specific web page. For example the tags of webPath can be used to set the context (from the contextDetails endpoint) and apply to the configuration.
  • Example: /content/mywebsite/homepage

2. contextEndpoint (optional)

  • Description: An API endpoint that provides a JSON containing URL or path patterns mapped to specific context. The configuration will compare the webPath parameter against these patterns to find matching context, which will then be used to generate the configuration.
  • Usage: This endpoint should return a JSON with a structure similar to: 
    {
  "data": [
    {
      "pattern": "/content/mywebsite/.*",
      "tags": [
        { "id": "tag1", "name": "Marketing" },
        { "id": "tag2", "name": "Homepage" }
      ]
    }
  ]
}
  • Example: https://assets-addon.adobeaemcloud.com/tags.json

3. LOG_LEVEL (optional)

  • Description: The log verbosity level for debugging. Possible values include info, debug, warn, error.
  • Usage: Useful for troubleshooting the behavior of the configuration, especially when debugging the dynamic tag generation.

Sample Requests

Here’s an example of how to invoke the hosted configuration with all parameters:

https://245265-extensionconfig-stage.adobeioruntime.net/api/v1/web/extension-config/extension-config
https://245265-extensionconfig-stage.adobeioruntime.net/api/v1/web/extension-config/extension-config?webPath=snorkling
https://245265-extensionconfig-stage.adobeioruntime.net/api/v1/web/extension-config/extension-config?webPath=snorkling&contextEndpoint=https://assets-addon.adobeaemcloud.com/tags.json

Response Example

The response will dynamically generate a configuration based on the matching tags from the provided contextEndpoint and the given webPath:

{
  "useProdDomain": true,
  "copyMode": [
    {
      "mimeType": "image/*",
      "value": "use-alt-text"
    }
  ],
  "filterSchema": [
    {
      "header": true,
      "groupKey": "AssetTagsGroup",
      "fields": [
        {
          "name": "property=metadata.application.xcm:keywords.id",
          "defaultValue": ["tag1", "tag2"],
          "options": [
            { "label": "Marketing", "value": "tag1" },
            { "label": "Homepage", "value": "tag2" }
          ]
        }
      ]
    }
  ]
}

How It Works

  • Without webPath: When no webPath is provided, the configuration will return a generic set of options defined in the config.
  • With webPath: If the webPath is provided, the app consider a context of the web page and applies to generate the configuration.