In this tutorial you will learn about how to use the CoreMedia Feedback Hub API. It explains step-by-step how to set up a new CoreMedia Extension for the Feedback Hub and how to build a new Feedback Hub adapter or provider with the corresponding classes, localization, error handling, etc.
To find out which CoreMedia versions are supported by this project, please take look at the releases section or on the existing branches. To find the matching version of your CoreMedia system, please checkout the branch with the corresponding name. For example, if your CoreMedia version is 2107.1, checkout the branch 2107.1.
There are two possibilities to implement your Feedback Hub adapter, depending on your use case. This tutorial covers both cases in separate sections:
FeedbackHubAdapter
The Feedback Hub has predefined FeedbackHubAdapters. They offer some prefabrication
to make the integration of similar services easier. One example for this
is the BlobKeywordsFeedbackHubAdapter which already gives us the data blob the keywords
should be extracted from. Please check the documentation for the list of existing
FeedbackHubAdapters.
Tutorial Link: Implementing a FeedbackAdapter
FeedbackProvider
The FeedbackProvider interface is the general interface to implement for any
kind of feedback. It does not offer any kind of prefabrication and can be used
if none of the existing FeedbackHubAdapters are applicable for your use case.
Tutorial Link: Implementing a FeedbackProvider
This repository is a plugin for the CoreMedia Blueprint workspace. To include it, you must perform the following steps:
- Clone this project
- Build it via
mvn clean install
To debug the Java code of you plugin, start the Studio Server of your CoreMedia Blueprint workspace in debug mode and pass the testsystem host name and the location of the plugin directory where the zip archive of this plugin is located. For example:
mvnDebug spring-boot:run -Dspring-boot.run.jvmArguments="-Dinstallation.host=my-test-system.vm -Dplugins.directories=C:/workspace/plugins"
Afterwards, create a "Remote Debug" configuration in IDEA with transport Socket,
host localhost and port 8000. The VM parameter should look like this:
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:8000
In IDEA, it should look like this:
When executed, the Studio server will start up and you will be able to debug your plugin.
The Studio client development for plugins is similar to the regular Studio development. Ensure that the Studio proxy is started for the main Studio.
Afterwards, execute
pnpm -r start
in the studio-client folder of your plugin. You will see that a proxy server is started under which the Studio is available. The additional Studio sources of the plugin will be available there.
Welcome to CoreMedia Labs! This repository is part of a platform for developers who want to have a look under the hood or get some hands-on understanding of the vast and compelling capabilities of CoreMedia. Whatever your experience level with CoreMedia is, we've got something for you.
Each project in our Labs platform is an extra feature to be used with CoreMedia, including extensions, tools and 3rd party integrations. We provide some test data and explanatory videos for non-customers and for insiders there is open-source code and instructions on integrating the feature into your CoreMedia workspace.
The code we provide is meant to be example code, illustrating a set of features that could be used to enhance your CoreMedia experience. We'd love to hear your feedback on use-cases and further developments! If you're having problems with our code, please refer to our issues section. If you already have a solution to an issue, we love to review and integrate your pull requests.