Message events are extremely useful as they enable processes to send emails to Barium Live users in different roles or groups as well as sending emails to external users based on form data. It can also be used to send process messages which can be used to trigger connected work flows and start other process applications. For example, messages can be used to tell somebody that your process has progressed to a certain phase, to send an automatic response that a registered case has been received, to inform an interested party that the process has passed a milestone or to inform one or more interested parties that the process has ended.
In the BPMN standard, Start, End and Intermediate Events can be of the type Message.
NOTE: Barium Live currently supports catching and throwing intermediate message events but neither catching or throwing interrupting/non-interrupting intermediate message boundary events. If you want in process communication, you can use signal events instead.
How to use Message Events
Throwing Message Events
Are used to send messages. They are represented by a darker email symbol. The event is configured either as an Email message or as a Process Message which will be thrown/sent when the event is triggered.
Catching Message Events
Are used to receive messages. They are represented by a lighter email symbol. The event is configured to receive a specific Process message and when this message is sent, the event will be triggered.
Configure a Message Event
1. Open the settings panel by double-click the Intermediate event and choosing either a throwing or catching event trigger.
3. Open the Configure message interface.
From this panel you can chose either to send an Email message or a Process message from the tabs at the top of the window.
3. If you want to configure an email message the interface lets you:
- Add recipients from four quick- Categories
- Compose your email subject and body
- Add a Reply to address
- Add a From name
- Add attachments
Message events have the capability of sending e-mails to the role members set in the process model, to groups within a work space, to an e-mail address that has been filled out in a form field, for example by the person who registered the case in the first place. Message events can also send emails to custom email addresses.
NOTE: You can add multiple categories by clicking them. It's possible to combine several email addresses from roles, groups, form fields and custom addresses. If an email address is present in two places, for example in a role and in a group, only one email will be sent to that person.
Compose emailThe email body text editor has some basic formatting functionality as well as the ability to edit HTML.
Read more on how to reference variables.
TIP: It’s possible to add variables in the e-mail text which reference information from the process instance or from form fields. For example: In a process you may have a form with a field for the “reviewers comments” allowing the reviewer to document the outcome of a review. The text filled out in the “reviewers comments” field can be inserted into the e-mail text through a variable and sent to whoever you choose to be the recipient.
Add reply to address
This sets a reply to address that will show up in the recipients address field if they want to respond to the message sent by Barium Live. This allows users to configure a reply to address of their own instead of email@example.com
Add from name
This sets a sender name that will show up in the email header. Note that default from name will be the application name
Files up to 5MB can be attached to an email thrown by a message event. It is possible to attach files to emails sent from message events in three different ways:
1. You can send files taken from attachment form fields by selecting the form field. These files can be of any format.
2. You can send an entire data object form as a PDF file by modelling the data object as an input to the send message event.
Doing this will cause it to show up in the attachment field automatically and sending the message will convert the form to PDF and make it available as an attachment to the email.
3. You can send generated documents as either PDF or docx files by modelling them as inputs to the send message event.
If you want the document to be converted to PDF instead of the default docx format, simply double click the document template modelled as an input and chose PDF generation.
Generated Document modelled as inputs to the send message event will show up in the attachment field automatically and sending the message will make it available as an attachment to the email.
NOTE: If a message contains more than 5MB worth of file attachments the message will still be sent but without the attachments. An error will be generated in the application event log.