Overview
The purpose of this document is to help you understand how to automate email sends within Mirata. We will discuss sending an email from a form using the workflow and backend integration actions.
Step 1: Create Integration Action
On the Admin tab, select Integration actions.
On the Integration Actions tab, select "Add Integration Action"
Once you create a new integration action, make sure to do the following on the Details tab:
Name the integration action
Set the "Action Request Type" to Email Notification Request
Add a description, if desired
Save your integration action
Step 2: Define Required Inputs
Navigate from the Detail tab to the Inputs tab.
Add your desired email input parameters. An input parameter is a placeholder for a value or set of values that a function, method, or process receives as input.
Common email inputs are:
Source Address | Who the email is sent from | Required |
To Address(es) | Who the email is going to | Required |
CC Address(es) | Email addresses to be CC’d | Optional |
BCC Address(es) | Email addresses to be BCC’d | Optional |
Subject | Subject of the email | Required |
Body | Body of the email (if static text) | Required |
Make sure to SAVE your inputs before proceeding.
Step 3: Set Email Notification Request Properties
Navigate to the Request tab. This is the part where we specify where each of the inputs are going to appear within the configuration of the actual email. It is important to note that when you reference your inputs in the request property configuration, you will need to utilize { } -- for example, {to-address}
Recall from the last step that there are 4 inputs:
source-address
to-address
subject
body
Address Info Section
The address info section is to help us decide who will be sending and who will be receiving the email.
In the Recipients property, we need to put the {to-address} input. Simply put, we would like whoever is the "recipient" to receive this email.
We also need to make sure that this is being sent from the appropriate email address. To do so, we will need to drop down the Advanced Configuration option and set the sender property to {source-address}.
Email Editor Section
The email editor section is where we decide the content of the actual email. This includes the subject and the body of the email. We are going to similarly reference the {subject} and {body} inputs in this section.
Step 4: Add Email Automation to Form/Workflows
For the purposes of demonstration, here is a simple form that contains all of the information that is necessary for field mapping with the email automation. This is important because we will need to map our form fields to the input parameters in the integration action.
There was also a new transition created to ensure that once we reach this part of the form, we can attach the automation to the transition.
In order to assign our email automation to the "Send email" transition, we will navigate to the Integration Actions with the transition selected.
Click the "+" button. Search for and/or select the appropriate integration action:
Step 5: Mapping Form Fields to Email Integration Action
At this point we need to make sure that we are correctly connecting the fields from the form to our email integration. To do so, all we will need to do is select the field from the form using the calculation option (Σ).
Change "constant" to "field" and select the appropriate field for each respective email input. Make sure to switch the Context from Transition to Form.
When completed, each backend field will have an associate value coming from our form.
Testing the Email Automation
In order to test this, we need to navigate to our forms Inbox and create a new version of our simple email form. I have added the following information into my form to test the email automation send.
On the bottom of your form, if you have added the correct step in the workflow, you will see a button that is associated with the transition that you linked your integration action to. In this example, our button is labeled "Send Email"
Once we fill out all the information, and click the button, we are going to wait to see if an email appears in our inbox.
Looks like it worked!