Reference Materials

Detailed information about CoreMedia Content Cloud. Go down the rabbit hole.

Version

   
Download all manuals from this version as ZIP

Select the distribution version for resources that are released with Agile Enhancement Packs (AEP) or Agile Maintenance Packs (AMP).

Filter

Select  

Target Group

Administrator
Business User
Developer
Editor

Components

Analytics
Blueprint
Commerce Hub
Content Application Engine
Content Hub
Content Server
Elastic Social
Feedback Hub
Feeder
Frontend Development Workspace
General
Headless Server
Importer
Ingest Service
Personalization
Studio
Studio Server
Studio Client
Site Manager
Search Engine
Unified API
Workflow Server

Document Type

Manual
API
Tutorial
Knowledge Base
Example Implementation
Tools
Other

Use Cases

Configuration
Deployment
Backend Development
Editorial Frontend Development
Frontend Development
Monitoring
Overview
Security
Studio Usage
Upgrade

Manual

Adaptive Personalization Manual

This manual describes the configuration of and development with Adaptive Personalization, the CoreMedia module for personalized websites. You will learn how to configure the GUI used in CoreMedia Studio, how to use predefined contexts and how to develop your own extensions.

Analytics Connectors Manual

This manual describes how you can connect your CoreMedia website with external analytic services, such as Google Analytics.

Blueprint Developer Manual

This manual contains the basic knowledge you should have when you want to develop with CoreMedia Content Cloud. It describes the basic features and concepts of the development workspace, of the Commerce integration and of the Corporate Blueprint features.

Content Application Developer Manual

This manual provides information on the administration and development of content applications using the Content Application Engine (CAE).

Content Server Manual

This manual describes the concepts and administration of the main CoreMedia component, the Content Server. You will learn about the content type model which lies at the heart of a CoreMedia system, about user and rights management, database configuration, and more.

Custom Commerce Adapter Developer Manual

This manual describes how to integrate a custom Commerce System with CoreMedia Content Cloud using the CoreMedia Commerce Hub architecture.

Deployment Manual

This manual is intended for architects and developers who want to learn about the concepts of CoreMedia's flexible deployment. You should be familiar with configuration management and application deployment concepts.

Elastic Social Manual

This manual describes the concepts and administration of the Elastic Social module and how you can integrate it into your websites.

Frontend Developer Manual

This manual is intended for frontend developers who plan to develop a frontend for the CoreMedia system.

Headless Server Developer Manual

This manual describes the concepts and configuration of and development with the Headless Server.

Importer Manual

This manual describes the concepts of the CoreMedia Importer. You will learn how to configure and start the existing XML Importer and how to create your own importers for arbitrary XML formats.

Multi-Site Manual

This manual provides an overview of the CoreMedia Multi-Site feature. It describes different options to design your site hierarchy and gives some guidance to avoid common pitfalls.

Operations Basics Manual

This manual is dedicated to administrators and developers of CoreMedia CMS installations. They will find descriptions of all tasks necessary for installation, configuration and operation of a CoreMedia system.

Search Manual

This manual describes the configuration and customization of the CoreMedia Search Engine and the two feeder applications: the Content Feeder and the CAE Feeder.

Site Manager Developer Manual (Deprecated)

This manual describes the configuration and customization of Site Manager, the Java based stand-alone application for administrative tasks. You will learn how to configure the Site Manager with property files and XML files and how to develop your own extensions using the Site Manager API.

Studio Developer Manual

This manual describes the concepts and extension of CoreMedia Studio. You will learn about the underlying concepts, how to use the development environment and how to customize Studio to your needs.

Studio User Manual (EN)

This manual describes the usage of CoreMedia Studio for editorial and administrative tasks.

Studio Benutzerhandbuch (DE)

Dieses Handbuch gibt den Anwendern von CoreMedia Studios einen Überblick über alle Konzepte und Funktionen, die sie für ihre tägliche Arbeit benötigen.

Unified API Developer Manual

This manual introduces and explains the Unified API, which is the recommended API for most applications that use CoreMedia CMS.

Upgrade Guide

This manual describes, how you can update from CMCC 10 to CMCC 11.

Workflow Manual

This manual describes the Workflow Server. This includes the administration of the server, the development of workflows using the XML language and the development of extensions.

Connector for commercetools Manual

This manual describes how the CoreMedia system integrates with commercetools.

Connector for HCL Commerce Manual

This manual describes how the CoreMedia system integrates with HCL Commerce.

Connector for Salesforce Commerce Cloud Manual

This manual describes how the CoreMedia system integrates with Salesforce Commerce Cloud.

Connector for SAP Commerce Cloud Manual

This manual describes how the CoreMedia system integrates with SAP Hybris.

API

Unified API Developer Manual

This manual introduces and explains the Unified API, which is the recommended API for most applications that use CoreMedia CMS.

CAE

CoreMedia Community login required.

The API documentation for the CAE App.

CAE Feeder

CoreMedia Community login required.

The API documentation for the CAE Feeder App.

Content Server

CoreMedia Community login required.

The API documentation for the Content Feeder App.

Headless Server

CoreMedia Community login required.

The API documentation for the Headless Server App.

Site Manager

CoreMedia Community login required.

The API documentation for the Site Manager App.

Studio Server

CoreMedia Community login required.

The API documentation for the Studio Server App.

Workflow Server

CoreMedia Community login required.

The API documentation for the Workflow Server App.

Common

CoreMedia Community login required.

The documentation of the API shared by all CoreMedia Apps, including the Unified API.

Middle

CoreMedia Community login required.

The documentation of additional API shared by all CoreMedia 'Middle Tier' Apps, that is, all Apps using the Unified API.

Studio ASDoc

CoreMedia Community login required.

The API documentation for the Studio Client App.

Studio TSDoc

Starting with CMCC v11, Studio Client is implemented in TypeScript. The public API is not yet available as HTML pages, but once your Blueprint workspace has been built, the API is on-hand in any IDE supporting TypeScript. Use auto-completion, documentation lookup and navigation / go to definition to explore the API and its documentation. Please take care that the documentation of classes you use contains the @public TSDoc tag.

Blueprint Frontend Javadoc

CoreMedia Community login required.

The documentation of the API which is a subset of the CAE API including content beans for frontend development.

Ingest Service API

The documentation of the Ingest Service API. The Ingest Service is a cloud-only service enabling you to develop your own importer-like applications for CoreMedia Content Cloud.

Tutorial

Generating RSS Feeds based on CoreMedia Headless Server

This tutorial explains how to write a Node.js application that connects with the CoreMedia Headless Server. The result is a webapp that delivers an RSS feed with selected CoreMedia teaser documents.

Retrieve Content from Headless Server for Integration into 3rd party Services

In this tutorial we show how a Headless Server client can be implemented with Java in order to access CoreMedia assets. It can be used for integrations into a digital asset management systems (DAM), social media or marketing tools.

Global Link Connector

GlobalLink Connect Cloud from Translations.com allows you to send content for translation into one or more languages, retrieve content automatically once the translation is complete, and access real-time information such as the translation status – all without leaving CoreMedia Studio.

Commerce Adapter Mock

CoreMedia Community login required.

The repository gives an example of how to implement a custom commerce adapter and provides a fully functioning Spring Boot service.

Knowledge Base

Knowledge Base

CoreMedia Community login required.

The CoreMedia product knowledge base for CoreMedia Community members and subscribers. You will find announcements of new release, knowledge base articles, security issues, known issues and more.

Example Implementation

Spark - The React Example App

Have you asked yourself how to build single-page applications or a progressive web apps with CoreMedia? Spark provides guidance and examples for developers on how to best develop applications by means of the data provided by the CoreMedia Content Cloud and its Headless server.

Social Media Hub

Integrate social networks into CoreMedia Studio. Publish articles, videos and images directly to various social networks, schedule your posts to save time, and customize your content for each channel to reach your audiences more efficiently.

CSV Reporting Extension

The CoreMedia CSV Reporting Extension allows users to generate reports in CSV format describing the state of a bulk selection of content.

Content Sync Adapter

The Content Sync Adapter enables CoreMedia Content Cloud users to conveniently transfer content items from one environment to another. A synchronization dialog makes it easy to select the content items of interest, including references, and intentionally import the preferred selection easily via the Ingest Service.

Commerce Hub Connector for Magento

This repository describes how to integrate the Magento commerce system with the CoreMedia system.

Adapter for Cloudinary

The repository lets you download the adapter and describes how to install and use the Cloudinary Content Hub Adapter.

Show Navigation Tree of Preferred Site

The repository describes how to install and use the Navigation Content Hub Adapter which shows you the navigation structure of your preferred site.

Adapter for Dropbox

The repository lets you download and describes how to install and use the Dropbox Content Hub Adapter.

Adapter for Filesystem

The repository lets you download and describes how to install and use the Content Hub Adapter for Filesystem which gives you access to the server's file system..

Adapter for CoreMedia

The repository lets you download and describes how to install and use the Content Hub Adapter for CoreMedia Repository which gives you access to the repository of another CoreMedia system.

Adapter for YouTube

The repository lets you download and describes how to install and use the Content Hub Adapter for YouTube which gives you access to YouTube videos and playlists.

Adapter for RSS

The repository lets you download and describes how to install and use the Content Hub Adapter for RSS which gives you access to articles from external RSS feeds.

Adapter for SiteImprove

The repository integrates the Siteimprove REST API into the CoreMedia system. It also enables the Siteimprove widget for the preview CAE.

Adapter for Searchmetrics

The repository integrates the SEO and content marketing platform Searchmetrics into the CoreMedia system.

Three Step Publication Workflow

Sometimes the 4-eyes principle is not sufficient. Check out the three step publication workflow to have your content approved and confirmed by more than one expert.

Scheduled Publication Workflow

Whatever you want your website visitors to see tomorrow: use the new scheduled publication workflow to publish content and assets at any specific point in time.

Tools

CoreMedia Application Plugin

The CoreMedia Application Plugin serves the purpose of standardizing and simplifying the building of applications build upon the cm.exe and cm.sh infrastructure provided by the com.coremedia.cms#application-runtime#zip artifact.

Other

Supported Environments

CoreMedia Community login required.

This document outlines the environments that CoreMedia supports with CoreMedia Content Cloud in the respective version and the environments that are known to work with the CoreMedia product based on customer feedback.

What's New

CoreMedia Community login required.

The latest product features and enhancements for each version. For more details, please refer to our 'What's New' section at https://documentation.coremedia.com/.

Utilized Open Source Software & 3rd Party Licenses

CoreMedia Community login required.

Third-Party software used in the CoreMedia system and the required licence text.

Release Notes

Get detailed information about the breaking changes, general changes and improvements, and bugfixes.

Blueprint Content Types Diagram

This section shows the different content types of CoreMedia Blueprint and you can access the diagram(s) as UML, PDF download or graphml file.

Error Codes

This section lists all CoreMedia error codes.

Copyright © 2022 CoreMedia GmbH, CoreMedia Corporation. All Rights Reserved.