S/FTP Export

S/FTP Exports allow you to upload a Civis File or Table to a FTP server. For table uploads, file sizes up to 5GB are supported. 

Reference Adding a S/FTP Credential if you need to setup a Platform Credential for connecting to the server.

Creating a S/FTP Export:

There are multiple ways that a new S/FTP Export script can be created.

1. Click this link to create a new S/FTP Export script
2. Use the template ID 629 via the Civis API
3. Create a SFTP Export from the top navigation bar by:
   1. Click Go to "Data" in the top navigation bar.
   2. Under "Exports", click select "S/FTP".

Export Script Parameters:

Script parameters can also be viewed at the template page. 

Protocol: Specify the transfer protocol to use. The options are 'FTP', 'FTP_TLS', or 'SFTP'.

Remote Host: Enter the URL of the S/FTP location, e.g. 'ftp.examplesite.com'.

Remote Port (Optional): Specify the port on which to establish the connection. If left blank, the default is 21 for FTP and 22 for SFTP.

Credential: Select the credential containing the appropriate username and password for the host.

Remote Directory: Specify the directory within the host to export files into, e.g. '/download/'.

Output Filename (Optional): Specify the name of the file to export. If blank, the filename defaults to 'export_TIMESTAMP.csv' for table exports and the Civis File name for Civis Files. Use '%d' to include date or %t to include timestamp in the filename.

Civis File ID: Provide the ID of the file to be uploaded. Either a Civis File ID or a schema.table must be provided.

Source Table Name: Specify the schema and table name which should be exported, e.g. 'schema.table'. Either a schema.table or Civis File ID must be provided.

Source Database: Specify the database in which the data is stored; Optional if only one database is available or you are using a Civis File ID.

Columns To Export (Optional): Specify a comma-separated list of columns to include in export. If left blank, the default is to include all columns.

If File Exists (Optional): Specify an action to take if the destination file already exists. The options are 'fail', 'increment', or 'overwrite'. The default is 'fail'.

Max Chunk Size (Advanced): If left blank, uses connection default. The default works for most connections.

Credential Password is a Private Key?: If the password to your FTP credential is a private key, check this box. In most cases it does not need to be checked.

Extra Auth Password (Optional): Custom credential, for SFTP only. 'password' should be a password to decrypt the key in your FTP credential, if that key is encrypted. 'username' is not needed.

The following parameters optional and only available when uploading a Civis Table:

Export with Headers?: Check the box to include the table headers as the first row in the exported file.

Custom Header: A comma separated list to use as file headers, in order. Ex: custom_1, custom_2, custom_3. Note, delimiter is automatically converted from commas into the appropriate type

Column Delimiter (Optional): Specify whether the delimiter in the file is a comma, tab, or pipe. The default is 'comma’.

Compression (Optional): File compression type, defaults to none

Export Without Quotes?: Check the box to export the file without quoting the fields.