This page describes how to use Census with SFTP.

πŸƒβ€β™€οΈ Getting Started

β€Œ In this guide, we will show you how to connect SFTP servers to Census and create your first sync.


1. Create an SFTP Destination in Census

    Once you are in Census, Navigate to Connections​
    Click the Add Service button
    Select SFTP in the dropdown list
    Name your Destination (for example, SFTP) and enter the host and username for your SFTP server. If your server requires a password instead of an ssh key, enter the password here. If a password is not provided, we will give you a public key to upload to your user on your SFTP server. For SFTP connections with no password, this error will be shown until the provided public key is uploaded:
    Once the public key has been uploaded, you can click the Test button again to see if we can connect to the SFTP server successfully. If so, you'll see this:
Your SFTP credentials will automatically be tested by ensuring we can set up a connection to the SFTP server.

2. Connect your Data Warehouse

Please follow one of our short guides depending on your data warehouse technology:
After setting up your warehouse, your Census Connections Page should look like this:

3. Create your first Sync

Now head to the Sync page and click the Add Sync button
In the " What data do you want to sync?" section
    For the Connection, select the data warehouse you connected in step 2
    For the Source, select a model or table in your warehouse
Next up is the "Where do you want to sync data to?" section
    Pick your SFTP destination (for us it is SFTP) as the Connection.
    A File Path text field populated with a placeholder file path will pop up below the connection:
    Change the file path to reflect the name and place of the csv file you want to send data to.
    File paths accept variables that are set when the sync is run, and you can see the preview of your file path if you were to run the sync right now in the Template Preview section.
    The full list of variables you can use to template your file path is:
    %Y => 4 number year like 1997
    %y => 2 number year like 97
    %m => zero padded month like 07
    %-m => month like 7
    %d => zero padded day like 03
    %-d => day like 3
    %H => zero padded 24 hour like 08 or 18
    %k => 24 hour like 8 or 18
    %I => zero padded 12 hour like 08 or 12
    %l => 12 hour like 8 or 12
    %M => zero padded minute like 04 or 56
    %S => zero padded second like 05 or 55
For the " How should changes to the source be synced?" section
    Mirror should automatically be selected.
Finally, select the fields you want to update in the Mapper in the "Which Fields should be updated?" section
    By default, all of your table columns will be added to the mapper. If you don't want that, simply remove the columns/fields you don't want to sync in the mapper.
The end result should look something like this:
Click the Next button to see the final preview which will have a recap of what will happen when you start the sync

4. Confirm the data was sent to your SFTP Server

Now go back to your destination or service, in our case we will go to our SFTP server and we should see a new file with the specified file path πŸŽ‰
That's it, in 4 steps, you used Census to sync data from your warehouse or source to your SFTP server πŸŽ‰

πŸ”„ Supported Sync Behaviors

β€Œ πŸ”‹ Contact us if you want Census to support more Sync Behaviors for this destination

πŸ’‘ Things to know about the SFTP connector

    If a password is not provided to the SFTP connection, an RSA token with an openssh formatted public key is provided to upload to the SFTP server.
    Data arrives in one file to the designated file path.
    Files are written as a csv with headers.
​Contact us if your use cases don't work with these current limitations, we plan on addressing at least a few of these limitations in the future!

πŸš‘ Need help connecting to SFTP?

β€Œ Contact us via [email protected] or start a conversion via the in-app chat.
Last modified 8d ago