Using SFTP schedules to setup report/dashboard to be sent to your SFTP folders every day. SFTP Schedules allow admins/analysts to schedule a report/dashboard to be sent to an SFTP destination.
Some common use cases:
- Backup report data periodically to an SFTP server
- Deliver data regularly to your partners' servers
How to Setup
This section describes how you can set up Holistics to export report data to your SFTP server.
Configuring SFTP Integration
To manage your SFTP connections, please visit Integrations Page
To add new SFTP connection, click Add SFTP Connection and fill the required information below
- Display Name: Add integration title to manage your different connections
- Host, Port: Address of the SFTP server
- Root Path: Destination files will be preceded by this path
- Username, Password: Credentials to access the SFTP server
- Holistics Public Key: If you are using public key authentication instead of username/password, please add Holistics public key to your authorized keys
SFTP User Permissions
You will need to restrict the permissions of the SFTP user on your side. Typically, you would create an user dedicated for SFTP purpose, and allow this user to only read and write files within the root path. Example here.
Setup an SFTP Schedule
In any report, click Export on the toolbar, choose Manage Schedules, then click New Schedule and Add SFTP Schedule
Then fill the required information below for your schedule export
- Exported Widget: Choose the widget you want to create Export Schedule
- SFTP Connection: Choose the connection you want to create Export Schedule, you can manage it at Integrations Page
- File Name: The path of the destination file. Holistics will create folders/files if they do not exist. Otherwise, that file will be overwritten (CSV/Excel files are supported). You are able to include/exclude headers and choose the suitable separator.
- Frequency: Besides sending Once/Hourly/Daily/Weekly/Monthly, Holistics also offers an option for users to customize their own frequency (e.g. every 10 minutes)
- Filter: Set the filter values for the report
Note: if you're on Object-based plan, each SFTP schedule will be 10 objects.
SFTP Schedule Execution Flow
A SFTP Schedule execution follows these steps:
- Execute the Query Report to get result data
- Write the result data to a temporary file in
$REMOTE_PATHis configured in the SFTP connection)
- Prepare the destination path: create the non-existing directories in the destination path
- Move the temporary file to destination path
Export Sequential Files based on Timestamp
Sometimes when writing to destination, you want the system to add new files (based on date/timestamp) instead of overwriting existing files.
The above will produce filenames like:
The variables you can use are:
$yesterday: Today or yesterday in
$yesterday_flatten: Today or Yesterday in
YYYYMMDD(don't have the dash
$timestamp: Unix timestamp
$source_title: Title of the report, in lowercase and has its special characters replaced by underscores. E.g. '[email protected]^*?t Table' -> 'sales_pivo_t_table'
How to Setup SFTP User on Your Server
This section will give you a step-by-step instruction on setting up a new user on your SFTP server that is dedicated for SFTP purpose. The new user will be restricted to access a specific directory and use SFTP commands only.
Run the following commands as root.
- Create the new user
- Create a new directory. Later, we will make sure the SFTP user can only access this directory by configuring
ChrootDirectory. It needs to be owned by user
rootin order for the
ChrootDirectoryconfiguration to work
/holisticsis owned by
root, new user
holistics_sftpshould not be allowed to write to that directory. Thus, we will create an inner directory where
holistics_sftpcan write to. In this example, we are creating a new folder named
exported. Later when you fill in the settings of the SFTP Connection in Holistics, you should input
exportedin Root Path, so that all output files will reside within this directory.
Restrict the access of new user by editing
The above config makes sure user
holistics_sftp can only read the directory
/holistics and can only use SFTP commands.
Restart sshd service