Configuration

This section explains each of the properties in the configuration blade

General

PropertyDescription

Collection

This associates the Agent to a specific Collection (default to that of the current Data Stream).

Refer to Collections and Stream Hosts to understand more about Collections.

Server

A valid SMTP server must be configured in order to send emails.

PropertyDescription

Use Connection Variables

Tick to use server variables for SMTP Server, SMTP Port, User, and Password; or enter the text manually.

SMTP Server

The url of the SMTP server to monitor for emails.

SMTP Port

The port on the server - defaults to port 25 if left blank.

User

The username to authenticate to the SMTP server.

Password

The password to authenticate to the SMTP server.

Authentication

The authentication mode used to connect to the email server: Basic (default) or OAuth (token-based).

Tenant ID

Tenant Id used for authentication (applies to OAuth Authentication Mode only).

Client ID

Client Id used for authentication (applies to OAuth Authentication Mode only).

Client Secret

Client Secret used for authentication (applies to OAuth Authentication Mode only).

Refresh Client Token Interval (hours)

A timespan between 1 (default) and 24 hours to specify how often should the Agent refresh the email client token (applies to OAuth Authentication Mode only).

Email Settings

PropertyDescription

Get From Email Address

The options to determine the From address are a Variable or Event Data.

From

The email address from which the email is sent.

When the Get From Email Address is Event Data, this can be a column or attribute from the input payload, or you can manually type in an address.

When the Get From Email Address is a Variable, select a system variable.

To

The email address(es) to which the email is sent. This can be column(s) from the input payload, or you can manually type in address(es).

CC

The email address(es) to which the email is sent as Carbon Copy (CC). This can be column(s) from the input payload, or you can manually type in address(es).

Bcc

The email address(es) to which the email is sent as Blind Carbon Copy (Bcc). This can be column(s) from the input payload, or you can manually type in address(es).

Use Email Template

Tick to upload a template file to use as the email's body, or enter the text manually.

Collate Email

Tick to send the current batch's events in a single email (appending the body generated for all the events); or send the events individually (applies if Use Email Template is ticked).

Subject

The text for the email subject, which can include Placeholders.

Body

The text to send in the body of the email, which can include Placeholders (applies if Use Email Template is not ticked).

Template File

The file to use as the body of the email, which can include Placeholders (applies if Use Email Template is ticked). See Template File Example for more details.

Refresh Placeholders

Click to populate the Placeholders grid with those defined in the Subject, Body, or Template File.

Placeholder Mapping

Placeholders, denoted by curly braces "{}", can be specified in the Subject, Body, and Template File settings. They are mapped to event data when the email is sent.

This grid will automatically refresh the list of valid placeholders whenever the Subject, Body, or Template File properties are changed.

PropertyDescription

PlaceHolder

The placeholder marker to replace.

Mapping

The column or attribute of the input payload to insert instead of the placeholder.

Before configuring the Transformation, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.

Endpoints

NameDescription

Input

This endpoint is used to receive data from the parent Agent.

Output

Events received from the parent Agent are made available to this endpoint with unchanged attributes and data.

Error

Errors encountered during the execution of this Agent will be published on this endpoint.

Template File Example

Below is an example of an Email Template for Collate Email.

The {{placeholdername}} serves as a placeholder. It is replaced with the mapped event data column from the first row of the batch Event Data at runtime.

To display event data in tabular format, prefix the placeholder name with add “repeat_" e.g. {{repeat_value}}.

Add the attribute name="repeat" to the tr tag in the Email HTML Template, which will render the event data.

The placeholder can be added inside the HTML properties to create a dynamic table style. E.g. <td style=”background-color:{{repeat_color}}”>

<html>
    <body>
        Title: {{Title}}
        <table>
            <tr>
                <td>Reading No</td>
                <td>Value</td>
            </tr>
            <tr name="repeat">
                <td style="background-color:{{repeat_Color}}">{{repeat_ReadingNo}}</td>
                <td>{{repeat_Value}}</td>
            </tr>
        </table>
    </body>
</html>

Last updated