Comment on page
Configuration
This section explains each of the properties in the configuration blade.

image

Property | Description |
---|---|
Collection | This associates the Agent to a specific Collection (default to that of the current Data Stream). |
A valid SMTP server must be configured in order to send emails.
Property | Description |
---|---|
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). |
Property | Description |
---|---|
From | The email address from which the email is sent. This can be a column from the input payload, or you can manually type in an address. |
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). |
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 all events are sent individually. Applies if Use Email Template is ticked. |
Subject | The text for the email subject. Placeholders can be used in this entry; see below. |
Body | The text to send in the body of the email. Placeholders can be used in this entry; see below. Applies if Use Email Template is not ticked. |
Template File | The file to use as the body of the email. Placeholders can be used in this entry; see below. Applies if Use Email Template is ticked. |
Refresh Placeholders | Click to populate the Placeholders grid with those defined in the Email Body. |
Placeholders can be specified in the Template File, Subject, and Body settings; which are automatically filled by data from the event when the message is sent.
Placeholder markers are denoted by curly braces "{}". The Placeholder Mapping grid is where these markers are linked to event data to be filled out. This grid will automatically search for and refresh the list of valid placeholders whenever the Template File, Subject, or Body settings are changed.
Property | Description |
---|---|
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.
Name | Description |
---|---|
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. |
Last modified 6mo ago