Batch CSV Integration

Overview

This integration type is used when you have to send files containing lead information directly to either an email address, FTP/FTPS/SFTP connection, or even a specific Dropbox folder.

With this integration, you will be able to build a CSV/Excel file and schedule sends on a specified day of the week at a certain time.

Prerequisites

Prior to setting up this integration you will have to determine what type of integration this will be in regards to the connection type: FTP/SFTP/FTPS/Dropbox or Email.

Please see below a breakdown of the prerequisites that would be required for the following connection types:

FTP and FTPS : 

• username
• password
• server
• port
• passive (true/false)
• path (optional)

SFTP: 

• username
• password
• server
• port 
• path (optional)

Dropbox:

• apiToken
• access_type
• path (optional)

Email: 

• recipients email address(es)

Configuration

1. Within your campaign, go to the Processr tab and select Integration. Click Add Job.

2. In the drop down, select Batch CSV Integration and click Save.

Include Fields

At the top, you can map your fields to the column headers you would like to see in the created file. Please note, the fields on the left will be the headers, and the fields on the right are the form fields that will be pulled through underneath them.

Note: You cannot change the field mappings while a batch file is pending delivery. If you need to move, add or remove fields for the integration you should only do this when there are no leads pending. If not, this will lead to your file formatting incorrectly and you may end up with data in the incorrect columns, or missing data.

File Type

The file type allows you to choose between two choices, with regards to which leads you want to receive in each file sent. You can choose to only receive new leads with each file sent, or receive all (billable) leads with each send.

There are two options here, default and cumulative. 

Default: Leads will only be sent out once - once a lead has been delivered, it will not appear in future batches within this campaign.

Cumulative: This file type means the file generated will contain all of the lead data within the campaign from the date that this file type was set to Cumulative. Every file sent will include all available leads that meet that criteria.

Note: if you change the file type mid-campaign, it will not apply retrospectively. This means if you switch a batch configuration to cumulative when leads have already been submitted under default, the leads from the default configuration will not be included in the cumulative send. In other words, it is only cumulative from the point when that setting is saved. 

In addition, any leads that have been deleted, invalidated, marked as test or undelivered will be removed from pending batches, meaning that when the file is ready to send, it will not send leads that were delivered but had their status changed prior to the file sending out.

Formatting

You also have the option to configure the Delimiters and Encapsulations that are used in the file. This affects how values will be displayed in the file sent.

You can enter the values for the csv_delimiter and csv_encapsulation here. The list of values accepted onto the platform are listed below:

Delimiters Delimiter refers to the separator in the created file; this is traditionally a comma for csv.  For example, a CSV delimiter: `value 1, value 2, value 3` where , is separating the data	Encapsulations Encapsulation is what a value is wrapped in, this is traditionally blank for csv. An example of this is: `"value 1", "value 2", "value 3", where " is encapsulating the data.
0 = none 1 = , 2 = ; 3 = \t (this is tab separated)	0 = none 1 = " 2 = ' 3 = \t (this is tab separated)

 

File Name and Format

By default, the file name is named using placeholders that reference the campaign and the timestamp of the file as follows: %campID%-%Y%-%m%-%d%-%H%-%i%.xlsx

This name can be changed however you will have to ensure that this ends with the following file types: .xlsx or .csv

Note: The file type in this file name should be the same as the file_format (found at the top of this integration). If you do change the file_format, be sure to update the file_name field as well. 

Similarly to the default file name, you will be able to use the following placeholders from the platform when creating your new file name if desired:

•  %campID% : This will pull through the Convertr Campaign ID.
•  %campaignName% : This will pull through the Convertr Campaign Name.
• %Y%-%m%-%d%-%H%-%i% : This will pull through the date and time that the file was created

Password Protection

You also have the option to password protect this file if needed. To do this, you need to send as a ZIP file. Your file will sit within this ZIP file, and the password input here will need to be used in order to open it.

Note: You will have to communicate what the password is to all your email recipients through communications outside of the platform. The password will be masked across the platform (i.e. in audit logs etc) however you can always view this in the configuration settings by clicking the following icon: 

Notification and BCC Emails

In the next section, you can input the email addresses that will be receiving the lead data. You can add/remove as many emails as necessary.

Adding email addresses to the notification_emails section will include all emails in cc. Using the bcc section will of course bcc the emails.

If you are not using the Email connection type to send your lead data, then the email addresses included here will receive an email notifying them that the leads were sent down the requested connection type. If set to Email, then they will be able to download the file directly.

Schedule

You will be able to select how often you want your file to be sent out. You can have the file send between 1-7 times a week (one per day at the least). You will be able to select what hour the file goes out, and it should be sent within that hour.

Connection

As mentioned in the intro, you have multiple options as to how you want this file to be sent out. You can see the options in the screenshot below:

Depending on the connection that you select, enter any further credentials that may be required. Once you select your connection type, click outside of the box to allow further connection requirements to populate if applicable.

FTP/SFTP/FTPS

FTP & FTPS have the same configuration requirements, but this will depend on which your client wants to use. Simply ask your contact for the endpoint details that are blank in the screenshot below. 

SFTP has similar configuration requirements but does not need the passive field.

Dropbox

With Dropbox, you will be asked for an API token. You can retrieve this by selecting 'Get Dropbox Token' at the very top of the configuration, and following the steps:

Finally, you can select your access type. There are two levels of access you can have to Dropbox, and this depends what's been given to you on the Dropbox side:

appFolderAccess: If you have only been given access to a single folder to upload to in Dropbox, then you can select this option.

fullAccess: If you have full access to the Dropbox instance, then you can select this option, and you will be able to choose which folder you want to send to, if applicable.

Path

The path is set in the previous section, but it applies to the FTP, FTPS, SFTP and Dropbox options.

If you want to direct the file to a particular folder, you can use the path field to specify this folder's location. By default, it is set to / (root folder).

Email

With Email, there is no additional setup in the connection type you need to do. However, there is an additional section which you can use to customise the text in the email if you wish:

Examples

ID	Section	Example Config
1	subject	##enterpriseName## Action - ##campaignName## (##campaignId##) - Download Lead Batch Integration Report
2	title	##enterpriseName## Action
3	sub_title	##campaignName## (##campaignId##) - Download Lead Batch Integration Report
4	body	Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.<br /> Enterprise Name: ##enterpriseName## <br /> Advertiser Name: ##advertiserName## <br /> Campaign Name: ##campaignName## <br /> Campaign ID: ##campaignId## <br /> Total Leads Delivered on Campaign: ##totalLeadsCampaign## <br /> Total Lead Cap of Campaign: ##totalCapCampaign## <br /> Total leads remaining on the campaign: ##totalLeadsRemaining## <br /> Number of leads in the file: ##totalLeadsAttached## <br /> Total Lead Cap of Campaign: ##totalCapCampaign## <br /> A total of ##totalLeadsAttached## leads have been successfully compiled and can be <a href='##batchLeadDownload##' style='color: #333333'>downloaded here</a>.** The list of Lead IDs follows:<br /> ##campaignLeadIds##

**Please note that this section in bold is the link to download the file. If this is removed, there will be no link available and you will not be able to download the file from the email.

Placeholders

Description	Placeholder
This will display the Enterprise Name	##enterpriseName##
This will display the Advertiser Name related to the campaign	##advertiserName##
This will display the Campaign Name	##campaignName##
This will display the Campaign ID	##campaignId##
Total Leads Delivered on Campaign	##totalLeadsCampaign##
Total Lead Cap of Campaign	##totalCapCampaign##
Number of leads in the file	##totalLeadsAttached##
Link to the file download	##batchLeadDownload##
List of lead ids in the file which are comma separated	##campaignLeadIds##
Total leads remaining on the campaign	##totalLeadsRemaining##

Once configured, the email sent would look like this: