Adding Custom Notifications - CMCC 10

Last updated 6 months ago

This guide has multiple versions

CMCC 11
CMCC 10

Learn how to add custom notifications to Studio

What you'll learn

Prepare Studio for using custom notifications

Prerequisites

A Blueprint workspace

Time matters

Reading time: 5 to 10 minutes

Should I read this?

This guide is for Developers.

Adding Custom Notifications

On several occasions, CoreMedia Studio shows notifications (see also Notifications. To add your own custom notifications to CoreMedia Studio is actually quite straightforward. In the following, the necessary steps are described.

For your server-side module where you want to create a notification, make sure you add a Maven dependency on notification-api. This module contains the NotificationService API.
Make sure that your web-app has a Maven dependency on com.coremedia.cms:notification-elastic. This module contains an Elastic Core based implementation of the NotificationService. For the Blueprint Studio web-app this is already taken care of by the extension module notification-elastic-studio-lib. By default, the provided NotificationService uses MongoDB.
Finally, take care of declaring a NotificationService Spring bean, either via component scan or explicit declaration.
For the Studio client side, you have to add the Maven dependency notification-studio-client to the module where you want to develop new notification UIs.
In addition, you have to activate the notifications framework via a plugin (for Blueprint Studio, this is already taken care of by the extension module bpbase-notification-studio-plugin):

<editor:StudioPlugin>
  <editor:configuration>
    <notifications:NotificationsStudioPlugin/>
  </editor:configuration>
</editor:StudioPlugin>

This guide has multiple versions

CMCC 11
CMCC 10

Is this page useful?