Using An SFTP Server

Why SFTP?

SFTP: SSH File Transfer Protocol

SSH: Secure SHell

If it's your first time connecting to an SFTP server, you may find this guide helpful. By scheduling a job that exports employee data from your existing HRIS provider and saves it to our SFTP server, you can automate your user management. Managerial changes, departments, etc. can be updated in one place, then the update will automatically feed into the Betterworks platform.

Basic Connection

Server address: sftp.betterworks.com

  • If your organization's Betterworks instance is on the EU data center, use this server address instead: sftp-eu.betterworks.com

Port: 22

To establish a connection to our server: 

  • Download an FTP client (i.e. FileZilla)
  • Enter the address of the server in the "Host" field
    • In FileZilla, this is located in the top toolbar
  • Enter your username and password
    • These credentials need to be provided by the Betterworks Support Team
  • Enter the Port
  • Click "Quickconnect" or press "Enter" (on your keyboard) to connect to the server
    • Click "Ok" if you receive a warning regarding an unknown host key

Leverage the SFTP Server to Manage Users 

Automatically

See this article

Manually

If automation proves too costly or complex, you can always leverage the SFTP server manually. Using whichever provider you have, you can export your user data, manually put into a template (see below) and upload onto the SFTP server using FileZilla or a similar client. This would be ad-hoc and you'd need to build the file yourself, but it can save you both money and developer resources. 

CSV Templates

FAQs

How often should I export?

We recommend doing so daily.

What should I name the file?

Each file should be uniquely identifiable. We recommend naming each file sent with the current date.

Where should I put the file?

The file needs to be placed in the "incoming" folder of the target destination in order to be automatically picked up for processing.

Can I encrypt my files further?

Yes. Although not required, we do support additional PGP encryption. PGP keys facilitate "encryption at rest", meaning that even if someone were to obtain your organization's HRIS credentials, they would not be unable to view the contents of the encrypted file without the PGP key to decrypt it. If you'd like to use PGP encryption, please contact support@betterworks.com. We will generate the PGP key pair and issue the public PGP key to you. The private key will be saved on our end in an encrypted manner.
 
Note: We do not currently support additional SSH or SCP (Secure Copy Protect) encryption.