Creating an email channel
Using the Campaigning Channel Editor, you can configure the following:
- Basic Details: Name, broadcaster, and API connection credentials
- Broadcast Parameters: Configure the parameters required by the ESP
- Output Settings: Settings to use for each output
- File Settings: Configure the file settings, such as CSV, zipped, and encoding
- Additional Variables: Append any additional variables, and how they're presented to the ESP, to match the broadcaster template requirements
Every email channel integration starts in the broadcaster's account web panel. You must access your existing broadcaster's web panel, or set up a new account.
Tip
Refer to the "Before you begin" page for your broadcaster for information specific to that ESP, and for tips on what to do before creating a channel.
To create a new broadcast channel:
-
Open the Campaigning Channel Editor, in Application Settings.
Note
The Application Settings page is available from the user menu. It's only visible if you have admin permissions.
You can manage application settings from the user icon in the top right, and selecting Application Settings.
-
Select the Campaigning Channel Editor.
The Channel Editor lists any existing defined channels under each channel type on the left.
-
Click the + Item icon to create a new channel.
Use the following options:
- Create A New: Channel
- Name: Enter a descriptive name for the channel
- Parent Folder: Email
Use a name that indicates some of the channel's features, for example the broadcaster name followed by whether the channel is set up for Upload Only or Upload and Broadcast — for example, "Email - MyESP" or "Email - MyESP Upload".
Note
The red ! icon displays until you've entered all the required fields.
-
Complete the channel editor pages, ensuring you've entered all the required settings.
Channel editor pages¶
Note
A blue highlighted field indicates a required field. Values shown below are examples only — the available options differ for each broadcaster.
Basic details¶
The Broadcast Parameters page displays when you select a broadcaster.
| Name | Description |
|---|---|
| Channel Name | Enter a name for the channel |
| Broadcaster | Select your broadcaster from the drop-down |
| Broadcaster Username | Enter your broadcaster API username, available from your broadcaster |
| Broadcaster Password | Enter your broadcaster API password, available from your broadcaster |
| Update Password | Displays once a password is set — use this button to change the password if required |
| Test Login | Confirms the details above are correct. A "Test login successful" message displays if the credentials are correct |
| Email Variable | Select Email Address from the drop-down |
| Advanced Email Variable Settings | The Email Variable drop-down enables the check-box option "Select email variable during campaign creation". This is for use with PeopleStage — don't use this channel option in Orbit |
| Email Variable Description Override | Optional. Enter the description, for example "Email Address". This must correspond to the email field within your broadcaster |
| Reply Email Address | The email address that receives notifications when the channel is used. This is not the reply email address used for the email send |
| Broadcaster Action | Default is Upload and Broadcast. Select Upload Only to upload the list without initiating a broadcast |
Broadcast parameters¶
Common parameters
| Parameter name | Parameter value |
|---|---|
| SFTP Private Key Path | If secure FTP is used and requires a private key, this should refer to the path and filename of that key |
| Use Dated List | Setting this to false removes the date and time stamp from the end of the file name. The default is true |
| Dated List Format | Enter the date format string for the date and time stamp, if created. The default value is yyyyMMdd-HHmmss |
| FTP Protocol | The FTP protocol used for the connection |
Output settings¶
| Name | Value |
|---|---|
| Allow in Transactional Output | Specific to PeopleStage and transactional campaigning. If you select Yes, you can send multiple emails to the same email address |
| Append to List | When selected, appends the output to an existing list |
| Number of Retries | The number of times to retry on failure of the channel. For broadcast channels, it's recommended you leave this at 0 — the delivery agent also has a retry value, so a value greater than 0 can result in multiple retries and undesirable results |
| Response File Key Type | Specific to channels where response gathering is set up in FastStats. The key field used to match responses to sends — this varies by broadcaster, depending on the fields they return in the response file. Should be set to Communication Key for your broadcaster |
| Message Content Type | Always set to Template (using the broadcaster template) |
| Retrieve Existing List Names | When selected, retrieves the existing list names from the broadcaster |
File settings¶
| Name | Value |
|---|---|
| Zip File | Default is deselected. Select this optional setting to compress the file if required |
| Output File Format | Default is Comma Separated Values (CSV) |
| Output Header | Default is Descriptions, which uses the title of the variable in the header |
| Delimiter | Default is Tab |
| Alpha Encloser | Default is None |
| Numeric Encloser | Default is None |
| Extras | Empty by default. Can reference the name of an Extras XML file — reserved for advanced use |
| Encoding | Default is UTF-8 |
Tip
Ordinarily, you'd use the default settings on this page unless the broadcaster explicitly requires a different option.
Additional variables¶
Common variables used in this section are Forename, Surname, and so on. The purpose here is to map any additional FastStats variables to the broadcaster's variables. For example, the Forename variable in FastStats might be named FirstName in the broadcaster. This ensures any broadcaster templates that use one of the additional variables are populated correctly.
-
Click the +Add Variable button to select a variable.
-
Click in the Search data box.
-
Select the variable to add from the system.
Text variable options: Variable Description Override and Formatting.
Selector and multi-response variable options: Choose Output, and Handle "Unclassified" as.
Formatting options.
Append Additional Variables Directly options — see below.
| Name | Value |
|---|---|
| Variable | Click to search the FastStats system for the additional variable |
| Variable Description Override | Optional. Use this field to override the variable header description to match the name in the broadcaster, for example Forename - FirstName |
| Formatting | Default is Unformatted. You can apply a naming convention to the variable — UPPERCASE, lowercase, or TitleCase |
| Append Additional Variables Directly | Deselected by default. Select this option to change how the additional variables are added to the list, either at the End or Beginning. When not set, variables append to the end of the list |
| Selector and Multi-Response | Additional options are available for these types of variables |
| Choose Output | Selects what to output — either the Description or the Code from the system design. The default is description |
| Handle "Unclassified" as | Select how to handle unclassified selector data — use the setting as specified in the system From Design, or send no content (Empty) |
Reply email address configuration in Apteco email¶
When configuring the reply email address in Apteco email, note the following:
- Basic Details tab: The reply email address specified here is used for notifications if there's an issue with the publish process.
- Parameters tab: The reply email address specified here is set for Apteco email. If this field is left blank, the system defaults to using the sender address specified in the Parameters tab.
Ensure these fields are correctly configured to manage reply emails effectively.