SFTP

The SFTP data stream enables DXA to deliver session and pageview data to an SFTP server every night.

Configuring the SFTP data stream

To enable the SFTP data stream:

On the navigation bar, go to Connect > Data Streams > Configure Data Streams > Cloud Storage > SFTP.
Under SFTP, select SFTP Integration Enabled.

The following settings appear:


Setting	Description
Data type	Select the type of experience data you want to deliver to the SFTP server every night. The following options are available: Session — Delivers all session data from the past 24 hours Page — Delivers all pageview data from the past 24 hours All — Delivers all session and pageview data from the past 24 hours
Schema version	Select a schema to define the data fields available in the session and pageview data sets to be delivered to the SFTP. Note: Learn more: Web Schema v7
Custom pageview fields	If necessary, select additional pageview data fields to use alongside the data fields defined in the selected Schema version.
Custom session fields	If necessary, select additional session data fields to use alongside the data fields defined in the selected Schema version.
Session Track Event	Select a session track event for delivery to the SFTP server.
Pageview Track Event	Select a pageview track event for delivery to the SFTP server.
Segment	Select a segment for delivery to the SFTP server.
Output type	Select the file type to export session or pageview data for delivery to the SFTP server.
Frequency	Select how frequently DXA exports data to the SFTP server.
Export hour	Select the hour to export session or pageview data every day.
Export period	Select the period to export session or pageview data from. The following periods are available: Previous 24 Hours — Exports session or pageview data from the 24 hours up to the hour selected in Export hour Previous Day — Exports session or pageview data from the hours of 00:00 to 23:59 the previous day
Timezone identifier	Select your timezone.
Output filename	Enter a filename to give exported session or pageview data. Use one of the following uppercase character combinations to provide a variable date convention: YYYY — Year, four digits Example: 2021 YY — Year, two digits Example: 21 MMM — Month, three letters Example: Jan MM — Month, two digits Example: 01 FFF — Month, in full Example: January DDD — Day of week, 3 letters Example: Mon DD — Day of month, two digits Example: 31 LLL — Day of week, in full Example: Monday HH — Hour, two digits (00-23) Example: 21 II — Minute, two digits (00-59) Example: 57 SS — Second, two digits (00-59) Example: 37 EEE — Time zone, three letters Example: GMT CCC — Date and time, ISO 8601 Example: 2024-02-12T15:19:21+00:00 RRR — Date and time, RFC 2822 Thu,_21_Dec_2021_16:01:07_+0200 AAA — Date and time, Atom Example: 2015-08-22T15:52:01+00:00 OOO — Date and time, cookie Example: Monday,_15-Aug2019_15:52:01_UTC
Use temporary filename	If necessary, select this option to send session or pageview data to a temporary TMP file until the export process completes. Note: This setting is recommended for high-traffic properties.
ZIP files to Archive	If necessary, select this option to deliver session or pageview data to the SFTP server in one ZIP file instead of 24 individual files for each hour of the day.
ZIP Archive filename	If you selected ZIP files to Archive, enter the filename to give the ZIP file. Use one of the following uppercase character combinations to provide a variable date convention: YYYY — Year, four digits Example: 2021 YY — Year, two digits Example: 21 MMM — Month, three letters Example: Jan MM — Month, two digits Example: 01 FFF — Month, in full Example: January DDD — Day of week, 3 letters Example: Mon DD — Day of month, two digits Example: 31 LLL — Day of week, in full Example: Monday HH — Hour, two digits (00-23) Example: 21 II — Minute, two digits (00-59) Example: 57 SS — Second, two digits (00-59) Example: 37 EEE — Time zone, three letters Example: GMT CCC — Date and time, ISO 8601 Example: 2024-02-12T15:19:21+00:00 RRR — Date and time, RFC 2822 Thu,_21_Dec_2021_16:01:07_+0200 AAA — Date and time, Atom Example: 2015-08-22T15:52:01+00:00 OOO — Date and time, cookie Example: Monday,_15-Aug2019_15:52:01_UTC
Date for the archive filename	If you selected ZIP files to Archive, select a date convention to use in the ZIP file name. The following options are available: Date zip file is created — Date used in the filename reflects when the ZIP file was created Date of earliest included data — Date used in the filename reflects the date of the earliest item of data in the ZIP file
Archive encoding	If you selected ZIP files to Archive, select the encoding type to use for the ZIP file.
SFTP Integration Enabled	Select this option to view all settings and integrate the SFTP server with DXA.
Host	Enter the SFTP hostname.
Port	Enter the SFTP port number.
Username	Enter the SFTP server username.
Password	Enter the SFTP server password.
Remote path	Enter the remote server path to export the data file to.

To save changes and integrate with DXA, click Save.