Cloud Service Configurations

Last update: May 3, 2023

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Configurations are designed to provide the logic and structure for storing service configurations.

You can extend the existing instances to create your own configurations.

Concepts

The principles used in developing the configurations have been based on the following concepts:

  • Services/Adapters are used to retrieve the configuration(s).
  • Configurations (e.g. properties/paragraphs) are inherited from the parent(s).
  • Referenced from analytics node(s) by path.
  • Easily extensible.
  • Has the flexibility to cater for more complex configurations, such as Adobe Analytics.
  • Support for dependencies (e.g. Adobe Analytics plugins need a Adobe Analytics configuration).

Structure

The base path of the configurations is:

/etc/cloudservices.

For each type of configuration a template and a component will be provided.This makes it possible to have configuration templates that can fulfil most needs after being customized.

To provide a configuration for a new services you need to:

  • create a servicepage in

    /etc/cloudservices

  • under this:

    • a configuration template
    • a configuration component

The template and component must inherit the sling:resourceSuperType from the base template:

cq/cloudserviceconfigs/templates/configpage

or base component respectively

cq/cloudserviceconfigs/components/configpage

The service provider should also provide the service page:

/etc/cloudservices/<service-name>

Template

Your template will extend the base template:

cq/cloudserviceconfigs/templates/configpage

and define a resourceType that points to the custom component.

/libs/cq/analytics/templates/sitecatalyst
sling:resourceSuperType = cq/cloudserviceconfigs/templates/configpage
allowedChildren = /libs/cq/analytics/templates/sitecatalyst
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
componentReference = cq/analytics/components/sitecatalyst
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/sitecatalystpage

/libs/cq/analytics/templates/generictracker
sling:resourceSuperType = cq/cloudservices/templates/configpage
allowedChildren = /libs/cq/analytics/templates/generictracker
allowedPaths = /etc/cloudservices/analytics/*, /etc/cloudservices/analytics/.*
jcr:content/
cq:designPath = /etc/designs/cloudservices
sling:resourceType = cq/analytics/components/generictrackerpage

Components

Your component should extend the base component:

cq/cloudserviceconfigs/templates/configpage

/libs/cq/analytics/components/sitecatalystpage

/libs/cq/analytics/components/generictrackerpage

After setting up your template and component you can add your configuration by adding subpages under:

/etc/cloudservices/<service-name>

Content Model

The content model is stored as cq:Page under:

/etc/cloudservices/<service-name>(/*)

/etc/cloudservices
/etc/cloudservices/service-name
/etc/cloudservices/service-name/config
/etc/cloudservices/service-name/config/inherited-config

The configurations are stored under the subnode jcr:content.

  • Fixed properties, defined in a dialog should be stored on the jcr:node directly.
  • Dynamic elements (using parsys or iparsys) use a subnode to store the component data.
/etc/cloudservices/service/config/jcr:content as nt:unstructured
propertyname
*
par/component/ as cq:Component
propertyname
*