Generic FTP
Integration type: Pre-defined
The Generic FTP Broadcaster can upload lists to an ESP that is not currently integrated with Apteco, or does not provide enough functionality to do so.
Additionally, once the list is uploaded, you can create your own post-load process to handle the list. If the ESP supports handling of additional variables, you can include the SendID to—in theory—track responses in Apteco.
Contact your partner's support or Apteco support if you would like more information on using the Generic FTP broadcast channel.
Note
We're working hard to update the full integration guide, which covers Response Gathering and PeopleStage.
Channel configuration in Orbit¶
Basic details¶
| Name | Description |
|---|---|
| Channel Name | Enter a name for the channel |
| Broadcaster | Select Generic FTP 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 | Displayed once a password has been set; use this to change the password if required |
| Test Login | The Test Login function is not supported with the Generic FTP broadcaster as no API connection exists in Apteco. We recommend you test the FTP credentials separately and complete the URN field in the Broadcast Parameters tab |
| Email Variable | Select Email Address from the drop-down |
| Email Variable Description Override | Optional—enter the description, for example "Email Address". This must correspond to the email field within the broadcaster |
| Reply Email Address | The email address that will receive notifications when the channel is used. This is NOT the reply email address used for the email send |
| Broadcaster Action | The default is Upload and Broadcast; select Upload Only for the Generic FTP as this integration does not use the broadcaster's API to trigger the broadcast |
Broadcast parameters¶
| Parameter Name | Parameter Value |
|---|---|
| URL | The FTP URL in the form ftp://{USERNAME}:{PASSWORD}@ftpsite/{FILENAME} |
| Private Key Path | If secure FTP is used above and requires a private key, this should refer to the path and filename of that key |
| Admin From Email | The from email address that administrative emails are sent from |
| File Mapping | A pipe-delimited list of header values that will overwrite any defined in your output sequences |
| Use Dated List | Selected by default; setting this to false removes the date and time stamp at the end of the file name |
| Dated List Format | The format for the dated list. The default is yyyyMMdd-HHmmss |
| Delimiter | Delimiter character |
| Encloser | Encloser character |
| URN Field Name | URN field name alias |
| Encoding | Encoding of the input file. Default is UTF8 unless specified differently by the broadcaster |
| Name | Value |
|---|---|
| Allow in Transactional Output | Specific to PeopleStage and Transactional Campaigning. If you select Yes, multiple emails can be sent to the same email address |
| Append to List | Not applicable for Generic FTP |
| Number of Retries | The number of times to retry on failure of the channel. Recommended (for Broadcast Channels) to leave this at 0 |
| Response File Key Type | The key field to match responses to sends. Varies from broadcaster to broadcaster |
| Message Content Type | Not applicable for Generic FTP |
| Retrieve Existing List Names | Not used for Generic FTP |
| 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; will use 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 |