Skip to main content

Notifications

In CMDBuild there are notifications based on emails and messages starting from the application (in-app notifications) displayed through popup.
Notifications are controlled from the core for a better control and a simpler updating of sending parameters when they need to be edited.
In the Administration Module you can configure accounts for email outgoing (SNMP) and incoming (IMAP) and also templates used to send notifications to operators (workflow system, widget, Task manager, etc.), as email and in-app.
In particular the centralized definition of templates used to send notifications in the processes simplifies its maintenance, so that the XPDL descriptor has not to be edited.

Account​

The function allows you to create new accounts to send and receive emails and edit the old ones.

There is the possibility of performing the following operations:

  • Configure a new account
  • Do searches on the configured accounts
  • Edit the selected account
  • Display the complete information related to the selected account
  • Delete the selected account
  • Set the current account as default account
  • Execute a test for the correct configuration of the account
  • Save inserted configurations
  • Exit without saving new configurations

Each account requires several parameters to be compiled, which are divided into the sections described below.

General properties​

The following information is required:

  • Name: Account name
  • Username: Used to access the email server
  • Password: Used to access the email server

Outgoing mail parameters​

The following information is required:

  • E-mail address: e-mail account
  • SMTP server: outgoing server
  • SMTP port: server port
  • Sent folder: folder where sent e-mails are filed
  • Enable SSL
  • Enable STARTTLS

Incoming mail parameters​

The following information is required:

  • IMAP server: incoming server
  • IMAP port: server port
  • Enable SSL
  • Enable STARTTLS

E-mail template​

This function allows you to create or edit email notification templates that will be used for enabled features (workflow system, widget, task manager, etc.).

There is the possibility of performing the following operations:

  • Create a new template
  • Do searches on configured templates
  • Edit the selected template
  • Display the complete information related to the selected template
  • Clone the selected template
  • Delete the selected template

Each template requires several parameters to be compiled, which are divided into the sections described below.

General properties​

The following information is required:

  • Name: template name
  • Description: template description
  • Keep sync: it shows you that the text of the e-mail is automatically updated when attributes used like email parameters vary (default = yes)
  • Confirm sync: it shows you that you have to confirm every time the e-mail sync edits the text when attributes used like parameters vary
  • Delay: it requires that the e-mail is sent later (after 1-2-4 hours, 1-2-4 days, 1-2 weeks, 1 month)

Template​

The following information is required:

  • Default account
  • Type of content: HTML or TEXT
  • From: sender's address
  • To: addressee's address (or list of several addresses separated by comma)
  • Cc: copy carbon address (or list of several addresses separated by comma)
  • Bcc: blind copy carbon address (or list of several addresses separated by comma)
  • Subject: notification subject
  • Body: notification body

Through CQL expressions you can customize your notification in each template field with information available in the current context (i.e. workflow variables used to send emails).

CQL expressions can include metadata you can define and consult through the icon "Show metadata" on the right above the field.

In-app notification template​

This function allows you to create or edit in-app notification templates that will be used for enabled features (workflow system, widget, task manager, etc.).

Management features are the same of email notification ones.
Each template requires several parameters to be compiled, which are divided into the sections described below.

General properties​

The following information is required:

  • Name: template name
  • Description: template description

Template​

The following information is required:

  • To: addressee's address (or list of several addresses separated by comma)
  • Subject: notification subject
  • Body: notification body

Through CQL expressions you can customize your notification in each template field with information available in the current context (i.e. workflow variables used to send emails).

CQL expressions can include metadata you can define and consult through the icon "Show metadata" on the right above the field.

This is an example of in-app notification received in the Administration Module.

Email signatures​

You can configure your signature and insert it at the bottom of your email text.

There is the possibility of performing the following operations:

  • Create a new signature
  • Do searches on the configured signatures
  • Edit the selected signature
  • Display the complete information related to the selected signature
  • Delete the selected signature
  • Disable the selected signature
  • Set the selected signature as default

Each signature needs some parameters to be compiled.

General properties​

The following information is required:

  • Name: signature name
  • Description: signature description
  • Signature: signature text (HTML)

Email queue​

The e-mail created by CMDBuild pass through a "queue", which can be checked through the features described in this paragraph.

There is the possibility of performing the following operations:

  • Start the email queue (note whether this is a test and no emails must be sent)
  • Stop the email queue
  • Force an email in queue to be sent