Creating a Configuration Headless Quick Start Guide

As a first step to getting started with headless in AEM as a Cloud Service, you need to create a configuration.

What is a Configuration?

The Configuration Browser provides a generic configuration API, content structure, resolution mechanism for configurations in AEM.

In the context of headless content management in AEM, think of a configuration as a workplace within AEM where you can create your Content Models, which define the structure of your future content and Content Fragments. You can have multiple configurations to separate these models.

If you are familiar with page templates in a full-stack AEM implementation, the usage of configurations for the management of Content Models is similar.

How to Create a Configuration

An administrator would only need to create a configuration once, or very seldomly when a new workspace is required for organizing your Content Models. For the purposes of this getting started guide, we only need to create one configuration.

  1. Log into AEM as a Cloud Service and from the main menu select Tools -> General -> Configuration Browser.

  2. Provide a Title and a Name for your configuration.

    • The Title should be descriptive.
    • The Name will become the node name in the repository.
      • It will be automatically generated based on the title and adjusted according to AEM naming conventions.
      • It can be adjusted if necessary.
  3. Check the following options:

    • Content Fragment Models
    • GraphQL Persistent Queries

    Create Configuration

  4. Tap or click Create

You can create multiple configurations if required. Configurations can also be nested.

NOTE

Configuration options in addition to Content Fragment Models and GraphQL Persistent Queries may be necessary depending on your implementation requirements.

Next Steps

Using this configuration, you can now move on to the second part of the getting started guide and create Content Fragment Models.

TIP

For complete details about the Configuration Browser, see the Configuration Browser documentation.

On this page