# FTP Server Export Integration [Learn more about FTP Server Import Integration](/int/ftp-server-import-integration). This article explains how to send job results directly to your FTP server, with FTPS (explicit) or FTPES (implicit). For sample workflows on how to export job results to your FTP server, view [Treasure Boxes](https://github.com/treasure-data/treasure-boxes/tree/master/td/ftp). ## Prerequisites - Basic knowledge of Treasure Data, including the TD [toolbelt](https://toolbelt.treasuredata.com/). - An FTP server ![](/assets/image-20191107-002705.3225b9cf7ce826079ba7e49654f973f710a0effb89859cfc933396812fbe8b22.9dee5338.png) ## Static IP Address of Treasure Data Integration If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection. Please find the complete list of static IP addresses, organized by region, at the following link: [https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/](https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/) ## Get your Credential for your FTP(S) Server Obtain your credential to access your FTP(S) server. ## Write the Query Navigate to the TD Console query editor page and compile your query. ### Specify the Result Export target In the same window, select **Add** in the Result Export section and select FTP from the drop-down menu. Edit all the information, including your Host, Port, Username, Password. If you want to connect to FTP Server with FTPS(explicit) or FTPES(implicit), select Use SSL? and select proper options. ![](/assets/image-20191107-003156.e7d49fa7c7a931d98a241e1cf232d330b9f8a6c7ba2699ebadffa2148e9de8d9.9dee5338.png) ### With PGP Encryption Configuration | Name | Description | Value | Default Value | Required | | --- | --- | --- | --- | --- | | format | The output format of file being uploaded file | Supported values: - csv - tsv | csv | NO | | encoders | Specifies the encoder's type of the output | Supported values: - "" - gz - bzip2 - encrypt_pgp | "" | NO | | public_key | The public key to use for encryption | String | | | | key_identifier | Specifies the Key ID of the encryption subkey used to secure the file. The master key is excluded from the encryption process. (string, required) | String | | | | amor | Use ASCII armor for the encrypted output (boolean) | Boolean | | | | compression_type | The compression type determines whether to compress the data before encrypting it. | Supported values - gzip -->  For example, file extension will be .csv.gz.gpg - bzip2 --> For example, file extension will be .csv.bz2.gpg - none --> For example, file extension will be .csv.gpg - zip_builtin --> For example, file extension will be .csv.zip.gpg - zlip_builtin --> For example, file extension will be .csv.z.gpg - bzip2_builtin --> For example, file extension will be .csv.bz2.gpg **Note: Please ensure that you compress your file before encrypting and uploading. When you decrypt it, the file will return to a compressed format such as .gz or .bz2.** | | | ### (Optional) Schedule Query Export Jobs You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify. Treasure Data's scheduler feature supports periodic query execution to achieve high availability. When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored. For example, if the cron schedule is `'0 0 1 * 1'`, then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed. #### Scheduling your Job Using TD Console 1. Navigate to **Data Workbench > Queries** 2. Create a new query or select an existing query. 3. Next to **Schedule**, select None. ![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png) 4. In the drop-down, select one of the following schedule options: ![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png) | Drop-down Value | Description | | --- | --- | | Custom cron... | Review [Custom cron... details](#custom-cron-details). | | @daily (midnight) | Run once a day at midnight (00:00 am) in the specified time zone. | | @hourly (:00) | Run every hour at 00 minutes. | | None | No schedule. | #### Custom cron... Details ![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png) | **Cron Value** | **Description** | | --- | --- | | `0 * * * *` | Run once an hour. | | `0 0 * * *` | Run once a day at midnight. | | `0 0 1 * *` | Run once a month at midnight on the morning of the first day of the month. | | "" | Create a job that has no scheduled run time. | ``` * * * * * - - - - - | | | | | | | | | +----- day of week (0 - 6) (Sunday=0) | | | +---------- month (1 - 12) | | +--------------- day of month (1 - 31) | +-------------------- hour (0 - 23) +------------------------- min (0 - 59) ``` The following named entries can be used: - Day of Week: sun, mon, tue, wed, thu, fri, sat. - Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec. A single space is required between each field. The values for each field can be composed of: | Field Value | Example | Example Description | | --- | --- | --- | | A single value, within the limits displayed above for each field. | | | | A wildcard `'*'` to indicate no restriction based on the field. | `'0 0 1 * *'` | Configures the schedule to run at midnight (00:00) on the first day of each month. | | A range `'2-5'`, indicating the range of accepted values for the field. | `'0 0 1-10 * *'` | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. | | A list of comma-separated values `'2,3,4,5'`, indicating the list of accepted values for the field. | `0 0 1,11,21 * *'` | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. | | A periodicity indicator `'*/5'` to express how often based on the field's valid range of values a schedule is allowed to run. | `'30 */2 1 * *'` | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. `'0 0 */5 * *'` configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. | | A comma-separated list of any of the above except the `'*'` wildcard is also supported `'2,*/5,8-10'`. | `'0 0 5,*/10,25 * *'` | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. | 1. (Optional) You can delay the start time of a query by enabling the Delay execution. ### Execute the Query Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination. Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications. (Optional) You can delay the start time of a query by enabling the Delay execution. ## Activate a Segment in Audience Studio You can also send segment data to the target platform by creating an activation in the Audience Studio. 1. Navigate to **Audience Studio**. 2. Select a parent segment. 3. Open the target segment, right-mouse click, and then select **Create Activation.** 4. In the **Details** panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters. 5. Customize the activation output in the **Output Mapping** panel. ![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png) - Attribute Columns - Select **Export All Columns** to export all columns without making any changes. - Select **+ Add Columns** to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select **+ Add Columns**to add new columns for your activation output. - String Builder - **+ Add string** to create strings for export. Select from the following values: - String: Choose any value; use text to create a custom value. - Timestamp: The date and time of the export. - Segment Id: The segment ID number. - Segment Name: The segment name. - Audience Id: The parent segment number. 1. Set a **Schedule**. ![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png) - Select the values to define your schedule and optionally include email notifications. 1. Select **Create**. If you need to create an activation for a batch journey, review [Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation). ## Usage from CLI You can also use CLI for Result Export to FTP(S). Example, ### CLI for FTP ```bash td query --result '{"type":"ftp","host":"xx.xx.xx.xx","port":21,"username":"xxxx","password":"xxxxx","path_prefix":"/path/to/file","file_ext":".csv","sequence_format":"","header_line":true,"quote_policy":"MINIMAL","delimiter":",","null_string":"","newline":"CRLF"}' -d sample_datasets "select * from www_access" -T presto ``` ### CLI for FTPS (Implicit mode) ```bash td query --result '{"type":"ftp","host":"xx.xx.xx.xx","port":990,"username":"xxxx","password":"xxxxx","passive_mode":true,"ascii_mode":true,"ssl":true,"ssl_explicit":false,"ssl_verify":false,"ssl_verify_hostname":false,"path_prefix":"/path/to/file","file_ext":".csv","sequence_format":"","header_line":true,"quote_policy":"MINIMAL","delimiter":",","null_string":"","newline":"CRLF"}' -d sample_datasets "select * from www_access" -T presto ``` ### CLI for FTPES (Explicit mode) ```bash td query --result '{"type":"ftp","host":"xx.xx.xx.xx","port":21,"username":"xxxx","password":"xxxxx","passive_mode":true,"ascii_mode":true,"ssl":true,"ssl_explicit":true,"ssl_verify":false,"ssl_verify_hostname":false,"path_prefix":"/path/to/file","file_ext":".csv","sequence_format":"","header_line":true,"quote_policy":"MINIMAL","delimiter":",","null_string":"","newline":"CRLF"}' -d sample_datasets "select * from www_access" -T presto ``` ### Legacy mode(Deprecated) We kept this feature for backward compatibility and will stop providing it in the near future. #### For On-Demand Jobs For on-demand jobs, just add the --result option to the td query command. After the job is finished, the results are sent to the specified FTP server. ```bash td query \ --result 'ftp://user:password@domain.com/path.csv' \ -w -d testdb \ "SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code" ``` If a port number is not specified, the default value is 21. The request body is in CSV format ([RFC 4180](http://www.ietf.org/rfc/rfc4180.txt)) where the first line is a header with the column names, the new line is CRLF, the text encoding is UTF-8, and the quotation character is double-quoted. ``` _c0,_c1 a,b c," d " e,f ``` ### For Scheduled Jobs For scheduled jobs, just add the --result option when scheduling a job. After every job run, the results are sent in the same manner as on-demand jobs. ```bash td result:create myftp ftp://user:password@domain.com/ td sched:create hourly_count_example "0 * * * *" \ -d testdb \ --result myftp:path.csv \ "SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code" ``` ## References - The Embulk-encoder-Encryption document: [https://docs.treasuredata.com/articles/#!project-integrations/~embulk-encoder-encryption-pgp](/int/embulk-encoder-encryption-pgp) ## FAQ for the FTP Data Connector Note: Please ensure that you compress your file before encrypting and uploading. 1.  When you decrypt using non-built-in encrypti on, the file will return to a compressed format such as .gz or .bz2. 1. When you decrypt using built-in encrypti on, the file will return to raw data.