FTP Export Profile

Owned by Developer Support (Unlicensed)
Last updated: Oct 17, 2023 by Joaquin David Menjivar-Couch (Unlicensed)
5 min read

Export Profiles are used to send data to a Postback URL of FTP. This article will walk you though the configuration for an Export Webhook sending data to an FTP server.

Generally these are used to send partials to a call center, but they are not limited to that function. We will send the field mappings you configure to the FTP server. Setting the mappings allow you to choose which CheckoutChamp data matches your 3rd party data. 

Please note that CheckoutChamp Test Card orders will not export through the webhook system.

Step 1: Go to ADMIN | EXPORT page by using the main navigation.

 

 




Step 2: Create a New Webhook Profile by clicking the greenbutton.

 

 



Next, Enter your Profile Name and select FTP as the export type

 

 

Configure the Export Profile and Click create. The profile will be added to your Export Webhook Profile List.

Step 3: Click edit to enter the profile configuration page:


Step 4: Configure General Settings This will take you to a page with two sections: General Settings and Field Mappings.

 

  • Profile Name: The name of the export profile. Can be whatever you want.Field Definitions:

  • Export Type: Type of FTP export

  • FTP Host: Host name of the FTP server

  • Username: Username used for logging into the FTP server

  • Password: Password used for logging into the FTP server

  • Protocol: FTP, SFTP or FTPS

  • Port: Port number used when connecting to the FTP server

  •  File Name: Name of file when posting to the FTP server.

The following token will insert the current date as part of the file name YMD. (The text inside the brackets is a date format string conforming to rules used by php's date object. http://php.net/manual/en/function.date.php)

  • File Name Examples (**Assuming the current date is March 1, 2016):

    • sales_[[YMD]].csv ? sales_160301.csv

    • sales_[[YMD]].csv ? sales_20160301.csv

    • sales_[[DMY]].csv ? sales_010316.csv

  • Export Frequency: Select either daily, weekly or monthly

  • Time of Day: Time of day that a daily export should be sent

  • Day of Week: Day of week that a week export should be sent

  • Day of Month: Day of month that a monthly export should be sent

  • PGP Encrypt File: Check this is you need to encrypt the file with PGP

  • PGP Encryption Key: This is the public PGP key used for encryption

    • Create separate line for each line item – Whether each line item in an order needs a corresponding line item in the CSV export. If unchecked, there will only be one line per order regardless of how many items were purchased as part of the order.

    • Include Column names in CSV file: If checked, column headers will be provided as the first line of the file.

    • Quote values in CSV file: Should values be quoted '”'

    • Quote null values in CSV file: If quoting values, should null values be quoted as well

  • Approve PCI: If you have PCI compliance documentation on file with Checkout Champ CRM, selecting the Approve PCI button will send the full card number to your payment processor, as opposed to just masked card number.

Step 5: Configure Field Mappings

First, click the green  button to add a Field Map

 

 

 

 

This will bring up a dialog box for adding a new field mapping. Field mappings essentially tell the system how to build the export file, which columns should be included and in what order.

Please view our available Field Mappings here!

Definition: - Export Name: the name of the column in the CSV file.

Field: the name of the field you are mapping from the CRM order record. - Static Value: If selecting “Static” as the field, then this represents the static (unchanging) value that is always used.

Example:

 

Mapping date created with Export Name 1/B:

 



Step 6. Configure Profile Routing

Now that you have your Profile setup and your fields mapped. It's time to setup which campaigns and products should be included in the export. Without a routing setup, the system does not know if you intend to export partials, sales, cancellations or which campaigns you want to export data from.

First, click on Export Profiles to go back

 

 

 

This will take you back to the page we visited in Step 1. On the right side of this page you'll see a section titled Profile Routing. Click the green + button to add a new route.

This will bring up a dialogue:

 

Partial – export only incomplete orders (also called leads)Use the select boxes to determine which products / campaigns and customer types should be included in the “Sales Export” daily FTP file. You can select from the following customer types:

Decline – export orders that declined

New Sale – export only new sales that were successfully billed

Upsell – export only orders that include an upsell

Recurring Order – export orders created as part of a continuity subscription

 

Example 1: Exporting partials on a specific campaign. This setup will include partials from only the Cheese Campaign (campaign Id 2).

 

 

 

Example 2: Exporting partials form 2 specific campaigns. To add an additional campaign to the export, simply repeat the process and select the second campaign.

 

Now the daily export file, will include all partials from both the "Cheese" Campaign and the “Clothing Store” Campaign.