Release Notes / Version 10.2104
Table Of ContentsCoreMedia Headless Server - Content as a Service
CoreMedia Headless Server is a framework which allows you to access your CoreMedia content as JSON through a GraphQL endpoint. Please consult the Headless Server Manual for Details.
The following new features are available now:
Search
Dynamic Query Lists
JSON Preview Client
E-commerce integration
For using Search together with the Headless Server, an existing Solr with index created by a CAE Feeder needs to be provided. The following functionality is supported:
Full text search
Paging
Filter by content type
Predefined sort fields with order
Limitation to a site
Limit
Search configuration is read from CMS content using settings, see the general search configuration for details.
Configuration properties:
solr.url: Url pointing to the Solr host
caas.solr.collection: Name of the solr collection. Should be created by a CAE Feeder.
caas.search.cache.seconds: Number of seconds to cache the search query (only for headless-server-live)
caas.querylist.search.cache.seconds: Number of seconds to cache the query list search query (only for headless-server-live)
Dynamic Query Lists require Search to be already set up.
The following functionality is supported:
Paging
Filter by content type, modification date, context, authors, subject taxonomy, location taxonomy, validity
Predefined sort fields
Limiting the result size
Note: Product Lists are not integrated into the Headless Server yet.
The CoreMedia Headless Server is be deployed as a Spring Boot application with Docker or Chef.
Configuration options for the headless-server-app:
caas.preview: true if preview mode is enabled
graphiql.enabled: true if graphiql tool should be deployed
caas.swagger.enabled: true if swagger tool should be deployed
The JSON Preview Client is deployed together with the
headless-server-preview
and can be used as a preview in CoreMedia Studio. If you do not need this application, you may remove the dependency to
preview-client
in the
headless-server-app
module.
Catalogs (by Site), Categories, Products and Product Variants are supported.
Moreover, some augmentation use cases are supported:
Fetching the corresponding Category from CMExternalChannel
Fetching the Product from a CMProductTeaser
Fetching associated CMVisual content (e.g. CMPicture) from augmented Categories and Products
Catalog image URLs for Categories and Products
For E-commerce, a running Commerce Hub is required with a proper configuration of at least one commerce adapter in the headless server app.
Depending on your system setup, this may be any combination of
commerce.adapter.sfcc.endpointcommerce.adapter.hybris.endpointcommerce.adapter.wcs.endpoint
For catalog image URLs, a site mapping has to be configured in the same way as for the CAE, e.g.
for local development:
blueprint.site.mapping.calista=http://localhost:49080
for Docker deployment:
BLUEPRINT_SITE_MAPPING_CALISTA: //preview.${ENVIRONMENT_FQDN:-docker.localhost
}
A running CAE instance is then required for the actual delivery of catalog images.
(CMS-14659)