Getting Started with Message Templates

This tutorial will guide you through the process of integrating Message Templates add-on into your application.

Project Setup

We are developing a Room Booking Application that demonstrates the use of the Message Template add-on in a Jmix project with the provided Booking entity. This application will showcase how to create, manage, and use message templates for notifications related to bookings.

Application administrators define message templates that are used to notify users after a meeting room reservation is made. Users receive both an email and a direct in-app notification following their booking.

  1. Create a base Jmix project. You can refer to the Tutorial section, which offers a detailed, step-by-step guide for developing the base application.

  2. Add the Message Templates add-on according to the installation section.

  3. To enable sending emails and in-app notifications, you’ll also need to install the Email Sending and Notifications add-ons.

About the Sample Application

This sample application demonstrates a basic Room Booking system. It provides a practical example of how to handle bookings and send notifications either directly within the application or via email, using a pre-existing message template.

The Booking entity is the core of the application, and the User entity (referenced as creator) represents the user who created the booking.