Message templates and message events are referenced together in the same message definition in order to configure messages. The business event also references a table. This allows message templates to interpolate data item values. This means that values found in the table can be referenced in the content of the template to provide business data. 

You can create multiple messages definitions with their own message templates for the same event. This would send out different messages to various recipients when the event is executed. For example, if an order is placed in the system, the message sent to the warehouse and the message sent to the financials team would be different. 

Learn more in the Message configuration topic. 

Configure messages

Configure messages to be sent to external and internal recipients with the Message Event Definition, Logic Block Builder, Message Template Setup, and Message Definitions applications. 

Configure messages with the following applications:

  • Message Event Definition application—Specify the table which you want to retrieve records from. This can include addresses for your emails, or interpolated values for your message content.
  • Logic Block Builder application—Create a logic block to queue the message event when the event is triggered. Optionally, map additional data sources to the event payload. 
  • Message Template Setup application—Define the content for the messages. Optionally, include interpolated values in your message content from the data source in your event payload. 
  • Message Definitions application—Define the message template, message event, and associated configuration. Together, they create the automated messages and notifications which the system sends to recipients. 

There are also optional configurations for messages. These are configured in the following applications:

  • Decision Builder application—Define conditional logic to determine which message template should be used. 
  • Group Definitions application—Define a predefined group that is specified as message recipients. 
  • Event Definitions application—Define the event to publish when a message reaches a status. 
  • Event Rules application—Route the published event to the logic block or other target that responds to it. 
  • Workflow Builder application—Define a workflow transition that prompts a message to be sent. To send messages for transitions, you must add a Post Run logic block to the transition that queues the message event to which your message definition is subscribed. To send notifications for workflow approval or rejections, you must configure an Approval Definition. See the Configure messages for workflow transitions, approvals, or rejections topic for more information. 

Prerequisites

To send messages, your tenant must be configured with an email domain. See the Email domain setup topic for more information. 

Message Event Definition

In the Message Event Definition application, create a message event and define the tables you want associated with your messages. Records from the tables can be referenced in the templates of your messages. See the Message events topic. 

Logic Block Builder

In the Logic Block Builder application, you must create a Post Run logic block over the event that you want to queue the message, then:

  • Select the Queue Event action.
  • In the Details panel, in the Message Event field, enter the name of the message event you configured. 
  • If the business event must be executed in a certain order in relation to other events, use the Sequential Execution Key field to specify a key.
  • Use the Payload Entries fields to map in values from a data source to the payload entry. These values can be used as interpolated values in the message content, or to provide recipients for the message.

Optionally, if you want a list of directory records to select your recipient from, you can also set up a logic block with the Build Directory Collection action. The logic block must not be a Background Task type logic block, since the logic block must run synchronously to provide the list of directory records to the system. This format is available for all of the recipient categories, such as Send To, Notify if no reciept found, and Email CC. The message is sent to each directory record provided by the logic block, going to the directory entry’s primary email or other email if specified. Once the logic block is built, enter it in the Logic Block field in the Message Definitions application. See Build Directory Collection action for more information.

Message Template Setup

In the Message Template Setup application, create one or more templates for your message. You can create different message templates for different message recipients, but they would each need their own message definition. For example, if an invoice is processed you may want to send a notification to the warehouse to ship the order, and a message to the billing department that the payment has cleared. 

To include interpolated values from a table in your message content, use the format of:
{​*PayloadEntriesName.DataItemName*​}

Where:

  • PayloadEntriesName is the name of the payload entry you created in the Payload Entries subtable in the message event.
  • DataItemName is the name of the data item from the table you referenced in the message event that you want in the message content.

If you do not specify the payload entry name, and only use {​*dataitemname*​} , the first payload entry in the subtable is defaulted. See Message Template Setup application for more information.

Message Definitions

In the Message Definitions application, you must:

  • Configure a message definition.
  • Select the Active checkbox or your message won't be sent.
  • Select the message event you created in the Triggering Message Event field.
  • Select the message template you created in the Message Template field, or use decision to select the template and enter the configured decision in the Template Decision field.
  • To use a logic block to designate the message recipient, enter it into the Logic Block field on the Recipient subtable. 
  • To use a decision to designate the template, enter it into the Template Decision field. 
  • Optionally, to publish an event when the message reaches a status, add a row to the Status Event Notifications subtable and select the event definition to publish. See the Event Definitions section below.

See Message Definitions application for more information.

Decision Builder

Optionally, if you want the system to determine which message template to use, you can create conditional logic using the Decision Builder application. 

  • Select Messaging for the Type field. This selection then defines your options in the Action field of the Rules subtable.
  • For the Match Policy field in the Decision Rules section, select the option relevant to your intended message recipients.
  • See the Decisions topic for more information. 

Groups

Optionally, if you have a predefined group of users that should receive messages, you can specify a group of designated recipients that has been defined in the Groups application.

Event Definitions

Optionally, if you want logic to run when a message reaches a status, such as Sent, Delivered, or Bounced, first create an event definition in the Event Definitions application. Then:

  • In the Message Definitions application, add a row to the Status Event Notifications subtable.
  • Select one or more message statuses.
  • Select your event definition.
  • In the Event Rules application, route the event to the target that should respond, such as a logic block.

When the message reaches any of the selected statuses, the platform publishes the event with the message record as its payload. See Event configuration for more information.