Skip to main content
Notifications

Learn more about project notifications

Updated over 3 months ago

Notifications in Kodexa is a new feature that allows project-level customization of event-triggered alerts. This system enables users to link specific events to notifications, enhancing communication and workflow management within the platform. The Notifications feature is designed to automate and streamline the process of keeping users informed about important events in their Kodexa projects.

High Level Overview

Type

Description

Option(s)

Name

Unique identifier of the Notifications.

User field text

Activity Type

This is a pre-defined list of available activities.

Drop-down list:

  • New Upload

  • New Data Available

  • Assignment Added

  • Assignment Removed

  • Custom Subscription

Notification Type

This identifies the type of notification

Current implementation only is Email Notification.

Custom Subscription

Subscription script (Spring Expression Language (SpEL)) for custom event.

Textbox Spring Expression Language (SpEL)

Include Assignee

Will automatically include the user assigned to the Document to be able to receive the notification.

Checkbox that will only appear for document related events (Assignment Added and Assignment Removed).

Recipient

E-mail address(es) of the users who will receive the e-mail notification. Multiple e-mail addresses should be comma-separated.

User field text that accepts e-mail address.

Subject

Subject of the e-mail that will be sent to the recipient.

User field text.

Email Body

Body of the e-mail that will be sent to the recipient.

User field text.

Manage Notifications

The list of created notifications is available under Manage Project > Notification. The table will list all notifications, their Activity Type, and Notification Type.

How to Create a Notification

To create notification, go to Manage Project > Notification > New Notification button. Fill out the information needed.

How to Create E-mail Body Using Jinja Template

The e-mail body accepts text using Jinja Template.

Jinja Context

Jinja Template

Project Name

{{ project.name }}

Filename

{{ documentFamily.path }}

Users (User name and Email)

{% for user in event.assignedUsers %}
<p>User name: {{
user.name }}</p>
<p>User email: {{ user.email }}</p>
{% endfor %}
โ€‹

User Name

{{ user.name }}

User Email

Document Status

{{ documentFamily.documentStatus.status }}

Here's a sample of an e-mail body:

<!DOCTYPE html>
<html>
<head>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
padding: 0;
background: #f4f4f4;
}

.email-container {
width: 600px;
margin: 0 auto;
padding: 20px;
}

.email-header {
background-color: #336699;
color: white;
padding: 20px;
text-align: center;
}

.email-content {
background-color: white;
padding: 20px;
text-align: left;
}

.email-footer {
background-color: #336699;
color: white;
padding: 10px;
text-align: center;
}
</style>
</head>
<body>
<div class="email-container">
<div class="email-header">
<h1>New File Uploaded {{ documentFamily.path }}</h1>
</div>
<div class="email-content">
<p>New File Uploaded for</p>
<p>Project Name: {{ project.name }} </p>
<p>File Name: {{ documentFamily.path }} </p>
<button color ="blue"><a href="https://dev3.kodexacloud.com/a/o/548d1374-8cce-4612-b867-7d710652c5cc/p/307886ea-df33-42e0-bff0-d54b1abf55a5/home">Access the project here</a></button>
</div>
<div class="email-footer">
<p>&copy; Kodexa. All rights reserved.</p>
</div>
</div>
</body>
</html>

Sample E-mail Notification

Did this answer your question?