Channel editor

Using the Campaigning Channel Editor, you can set up new, or manage existing, channels in Apteco for campaigning in Orbit.

You can manage the whole process of setting up a broadcast channel, creating an audience, then sending a broadcast from within Orbit:

Tip

You can configure channels to Upload and Broadcast, or Upload Only.

A system administrator uses the channel editor to create new, or manage existing, broadcast channels.
Orbit users can either use an existing audience, analyse dashboards to create an audience, or create a new audience, then use the email broadcast integration in the audience Export step to select an Upload and Broadcast channel. Orbit users can then send a one-off email for immediate broadcast.
Orbit creates a campaign, which you can monitor to confirm it sent successfully.
Optionally, Orbit users can use an Upload Only channel to upload the list to the broadcaster and then schedule the send using the broadcaster's web panel, or simply use Apteco Email.

Note

You can use Orbit or PeopleStage to create or manage channels. Only one administrator can use the channel editor in a system at the same time. For other administrators, it displays as checked out in PeopleStage or read-only in Orbit.

Administrators can take over a locked channel editor. For more details, see Editing the channel editor when locked out.

Note

You don't need a campaigning licence to use the channel editor, but you do need some PeopleStage roles and permissions.

Warning

This guide assumes you have access to the required information and the relevant administration experience to perform this task, particularly with preparing your broadcaster. If you don't, contact your Apteco partner or the Apteco support team.

You also need access to the broadcaster's web-based control panel and all the relevant information, and you need to understand how to set up your broadcaster with the relevant details to hand.

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 details specific to that ESP. It also has 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.
Select 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 channel features, such as the broadcaster name and the channel type, 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¶

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 you configure a password. Use this button to change the password if required
Test Login	Confirms the details you entered 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 you use the channel. This isn't 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¶

The Broadcast Parameters page displays when you select a broadcaster.

Common parameters

Parameter name	Parameter value
SFTP Private Key Path	If you use secure FTP and it 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 you set up response gathering in FastStats. The key field used to match responses to sends varies by broadcaster, depending on the fields they return in the response file. Set this 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	Deselected by default. 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 include Forename and Surname. The purpose here is to map any additional FastStats variables to the broadcaster's variables. For example, the Forename variable in FastStats might use the name FirstName in the broadcaster. This ensures any broadcaster templates that use one of the additional variables populate correctly.

Select the +Add Variable button to select a variable.
Select 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.

For Append Additional Variables Directly options, see below.

Name	Value
Variable	Select 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 where the additional variables go in the list, either 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: Use the reply email address specified here for notifications if there's an issue with the publish process.
Parameters tab: The reply email address here applies to Apteco Email. If you leave this field blank, the system defaults to using the sender address specified in the Parameters tab.

Configure these fields correctly to manage reply emails.

Managing channels¶

Campaigning Channel Editor additional options.

Duplicating a channel¶

To duplicate a channel:

Hover over a channel and select the options menu.
Select the Duplicate icon.

Orbit creates a duplicate channel.
Change the Channel Name and select Save All Changes.

Creating a folder¶

To create a folder, select the +Item button.
Select Folder from the Create a New drop-down menu.
Enter a Name for the folder.
Select the Parent Folder.