loading table of contents...

Headless Server Developer Manual / Version 2310

Table Of Contents



Binary Large Object or short blob, a property type for binary objects, such as graphics.


Content as a Service or short caas, a synonym for the CoreMedia Headless Server.

CAE Feeder

Content applications often require search functionality not only for single content items but for content beans. The CAE Feeder makes content beans searchable by sending their data to the Search Engine, which adds it to the index.

Content Application Engine (CAE)

The Content Application Engine (CAE) is a framework for developing content applications with CoreMedia CMS.

While it focuses on web applications, the core frameworks remain usable in other environments such as standalone clients, portal containers or web service implementations.

The CAE uses the Spring Framework for application setup and web request processing.

Content Bean

A content bean defines a business oriented access layer to the content, that is managed in CoreMedia CMS and third-party systems. Technically, a content bean is a Java object that encapsulates access to any content, either to CoreMedia CMS content items or to any other kind of third-party systems. Various CoreMedia components like the CAE Feeder or the data view cache are built on this layer. For these components the content beans act as a facade that hides the underlying technology.

Content Delivery Environment

The Content Delivery Environment is the environment in which the content is delivered to the end-user.

It may contain any of the following modules:

  • CoreMedia Master Live Server

  • CoreMedia Replication Live Server

  • CoreMedia Content Application Engine

  • CoreMedia Search Engine

  • Elastic Social

  • CoreMedia Adaptive Personalization

Content Feeder

The Content Feeder is a separate web application that feeds content items of the CoreMedia repository into the CoreMedia Search Engine. Editors can use the Search Engine to make a full text search for these fed items.

Content item

In CoreMedia CMS, content is stored as self-defined content items. Content items are specified by their properties or fields. Typical content properties are, for example, title, author, image and text content.

Content Management Environment

The Content Management Environment is the environment for editors. The content is not visible to the end user. It may consist of the following modules:

  • CoreMedia Content Management Server

  • CoreMedia Workflow Server

  • CoreMedia Importer

  • CoreMedia Site Manager

  • CoreMedia Studio

  • CoreMedia Search Engine

  • CoreMedia Adaptive Personalization

  • CoreMedia Preview CAE

Content Management Server

Server on which the content is edited. Edited content is published to the Master Live Server.

Content Repository

CoreMedia CMS manages content in the Content Repository. Using the Content Server or the UAPI you can access this content. Physically, the content is stored in a relational database.

Content Server

Content Server is the umbrella term for all servers that directly access the CoreMedia repository:

Content Servers are web applications running in a servlet container.

  • Content Management Server

  • Master Live Server

  • Replication Live Server

Content type

A content type describes the properties of a certain type of content. Such properties are for example title, text content, author, ...


Contributions are tools or extensions that can be used to improve the work with CoreMedia CMS. They are written by CoreMedia developers - be it clients, partners or CoreMedia employees. CoreMedia contributions are hosted on Github at

Control Room

Control Room is a Studio plugin, which enables users to manage projects, work with workflows, and collaborate by sharing content with other Studio users.

CORBA (Common Object Request Broker Architecture)

The term CORBA refers to a language- and platform-independent distributed object standard which enables interoperation between heterogenous applications over a network. It was created and is currently controlled by the Object Management Group (OMG), a standards consortium for distributed object-oriented systems.

CORBA programs communicate using the standard IIOP protocol.

CoreMedia Studio

CoreMedia Studio is the working environment for business specialists. Its functionality covers all the stages in a web-based editing process, from content creation and management to preview, test and publication.

As a modern web application, CoreMedia Studio is based on the latest standards like Ajax and is therefore as easy to use as a normal desktop application.

Dead Link

A link, whose target does not exist.

Derived Site

A derived site is a site, which receives localizations from its master site. A derived site might itself take the role of a master site for other derived sites.


A Document Type Definition is a formal context-free grammar for describing the structure of XML entities.

The particular DTD of a given Entity can be deduced by looking at the document prolog:

<!DOCTYPE coremedia SYSTEM ""

There're two ways to indicate the DTD: Either by Public or by System Identifier. The System Identifier is just that: a URL to the DTD. The Public Identifier is an SGML Legacy Concept.

Elastic Social

CoreMedia Elastic Social is a component of CoreMedia CMS that lets users engage with your website. It supports features like comments, rating, likings on your website. Elastic Social is integrated into CoreMedia Studio so editors can moderate user generated content from their common workplace. Elastic Social bases on NoSQL technology and offers nearly unlimited scalability.


EXML is an XML dialect used in former CoreMedia Studio version for the declarative development of complex Ext JS components. EXML is Jangaroo 2's equivalent to Apache Flex (formerly Adobe Flex) MXML and compiles down to ActionScript. Starting with release 1701 / Jangaroo 4, standard MXML syntax is used instead of EXML.


A folder is a resource in the CoreMedia system which can contain other resources. Conceptually, a folder corresponds to a directory in a file system.

Headless Server

CoreMedia Headless Server is a CoreMedia component introduced with CoreMedia Content Cloud which allows access to CoreMedia content as JSON through a GraphQL endpoint.

The generic API allows customers to use CoreMedia CMS for headless use cases, for example delivery of pure content to Native Mobile Applications, Smartwatches/Wearable Devices, Out-of-Home or In-Store Displays or Internet-of-Things use cases.

Home Page

The main entry point for all visitors of a site. Technically it is often referred to as root document and also serves as provider of the default layout for all subpages.


Document series of Best current practice (BCP) defined by the Internet Engineering Task Force (IETF). It includes the definition of IETF language tags, which are an abbreviated language code such as en for English, pt-BR for Brazilian Portuguese, or nan-Hant-TW for Min Nan Chinese as spoken in Taiwan using traditional Han characters.


Component of the CoreMedia system for importing external content of varying format.

IOR (Interoperable Object Reference)

A CORBA term, Interoperable Object Reference refers to the name with which a CORBA object can be referenced.


Jangaroo is a JavaScript framework developed by CoreMedia that supports TypeScript (formerly MXML/ActionScript) as an input language which is compiled down to JavaScript compatible with Ext JS. You will find detailed descriptions on the Jangaroo webpage Jangaroo 4 is the ActionScript/MXML/Maven based version for CMCC 10. Since CMCC 11 (2110), Jangaroo uses TypeScript and is implemented as a Node.js and npm based set of tools.

Java Management Extensions (JMX)

The Java Management Extensions is an API for managing and monitoring applications and services in a Java environment. It is a standard, developed through the Java Community Process as JSR-3. Parts of the specification are already integrated with Java 5. JMX provides a tiered architecture with the instrumentation level, the agent level and the manager level. On the instrumentation level, MBeans are used as managed resources.


JSP (Java Server Pages) is a template technology based on Java for generating dynamic HTML pages.

It consists of HTML code fragments in which Java code can be embedded.


Locale is a combination of country and language. Thus, it refers to translation as well as to localization. Locales used in translation processes are typically represented as IETF BCP 47 language tags.

Master Live Server

The Master Live Server is the heart of the Content Delivery Environment. It receives the published content from the Content Management Server and makes it available to the CAE. If you are using the CoreMedia Multi-Master Management Extension you may use multiple Master Live Server in a CoreMedia system.

Master Site

A master site is a site other localized sites are derived from. A localized site might itself take the role of a master site for other derived sites.


With Multipurpose Internet Mail Extensions (MIME), the format of multi-part, multimedia emails and of web documents is standardised.


MXML is an XML dialect used by Apache Flex (formerly Adobe Flex) for the declarative specification of UI components and other objects. Up to CMCC 10 (2107), CoreMedia Studio used the Open Source compiler Jangaroo 4 to translate MXML and ActionScript sources to JavaScript that is compatible with Ext JS 7. Starting with CMCC 11 (2110), a new, Node.js and npm based version of Jangaroo is used that supports standard TypeScript syntax instead of MXML/ActionScript, still compiling to Ext JS 7 JavaScript.


On personalised websites, individual users have the possibility of making settings and adjustments which are saved for later visits.


With projects you can group content and manage and edit it collaboratively, setting due dates and defining to-dos. Projects are created in the Control Room and managed in project tabs.


In relation to CoreMedia, properties have two different meanings:

In CoreMedia, content items are described with properties (content fields). There are various types of properties, e.g. strings (such as for the author), Blobs (e.g. for images) and XML for the textual content. Which properties exist for a content item depends on the content type.

In connection with the configuration of CoreMedia components, the system behavior of a component is determined by properties.

Replication Live Server

The aim of the Replication Live Server is to distribute load on different servers and to improve the robustness of the Content Delivery Environment. The Replication Live Server is a complete Content Server installation. Its content is an replicated image of the content of a Master Live Server. The Replication Live Server updates its database due to change events from the Master Live Server. You can connect an arbitrary number of Replication Live Servers to the Master Live Server.


A folder or a content item in the CoreMedia system.


A ResourceUri uniquely identifies a page which has been or will be created by the Active Delivery Server. The ResourceUri consists of five components: Resource ID, Template ID, Version number, Property names and a number of key/value pairs as additional parameters.

Responsive Design

Responsive design is an approach to design a website that provides an optimal viewing experience on different devices, such as PC, tablet, mobile phone.


A site is a cohesive collection of web pages in a single locale, sometimes referred to as localized site. In CoreMedia CMS a site especially consists of a site folder, a site indicator and a home page for a site.

A typical site also has a master site it is derived from.

Site Folder

All contents of a site are bundled in one dedicated folder. The most prominent document in a site folder is the site indicator, which describes details of a site.

Site Indicator

A site indicator is the central configuration object for a site. It is an instance of a special content type, most likely CMSite.

Site Manager

Swing component of CoreMedia for editing content items, managing users and workflows.

The Site Manager is deprecated for editorial use.

Site Manager Group

Members of a site manager group are typically responsible for one localized site. Responsible means that they take care of the contents of that site and that they accept translation tasks for that site.


In CoreMedia, JSPs used for displaying content are known as Templates.


In Blueprint a template is a predeveloped content structure for pages. Defined by typically an administrative user a content editor can use this template to quickly create a complete new page including, for example, navigation, predefined layout and even predefined content.

Translation Manager Role

Editors in the translation manager role are in charge of triggering translation workflows for sites.

User Changes web application

The User Changes web application is a Content Repository listener, which collects all content, modified by Studio users. This content can then be managed in the Control Room, as a part of projects and workflows.


Most of the time used in context of content variants, variants refer to all localized versions within the complete hierarchy of master and their derived sites (including the root master itself).

Version history

A newly created content item receives the version number 1. New versions are created when the content item is checked in; these are numbered in chronological order.

Weak Links

In general CoreMedia CMS always guarantees link consistency. But links can be declared with the weak attribute, so that they are not checked during publication or withdrawal.

Caution! Weak links may cause dead links in the live environment.


A workflow is the defined series of tasks within an organization to produce a final outcome. Sophisticated applications allow you to define different workflows for different types of jobs. So, for example, in a publishing setting, a document might be automatically routed from writer to editor to proofreader to production. At each stage in the workflow, one individual or group is responsible for a specific task. Once the task is complete, the workflow software ensures that the individuals responsible for the next task are notified and receive the data they need to execute their stage of the process.

Workflow Server

The CoreMedia Workflow Server is part of the Content Management Environment. It comes with predefined workflows for publication and global-search-and-replace but also executes freely definable workflows.


XLIFF is an XML-based format, standardized by OASIS for the exchange of localizable data. An XLIFF file contains not only the text to be translated but also metadata about the text. For example, the source and target language. CoreMedia Studio allows you to export content items in the XLIFF format and to import the files again after translation.

Search Results

Table Of Contents

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.