Set Up an SFTP Integration

Interested in setting up an SFTP integration to simplify user management and keep your user information transfer secure? Let us help you set up the integration so that you can drop files into an SFTP server to automatically invite and deactivate users.

OVERVIEW 

1. Functionalities 

  • Add users 
  • Update user details
  • Re-activate/Deactivate users 

2. Identifier (also known as Differentiator) options 

  • If employee_id is present in the file, will we use it as the identifier. 
  • If employee_id is not present, we will use email as the identifier. 
  • If both employee_id and email are not present, we will ignore/skip that user. 

3. Synchronization options 

There are 2 options; please let us know which option you will use, as this will need to be configured by our developers first: 

Option 1: Full file synchronization 

  • Requires all users to be in one file. 
  • New users in the file will be added to TINYpulse. 
  • Users that are removed from the file will be deactivated in TINYpulse. 

Option 2: Delta file synchronization 

  • Does not require all users to be in one file. 
  • Users that do not exist in TINYpulse will be added. 
  • User deactivation requires a reference from a specified custom column (e.g. termination, deactivation, deactivation date, termination date, …

4. Other options 

  • Send invitations to newly added users immediately.
  • Send Onboard surveys (if applicable). 

What We Need From You

In order to start the SFTP integration, please generate an SSH key pair and send the public key to our Support team by clicking this link. Make sure to keep a copy of the private key for yourself as well. 

In addition to the public SSH key, please send us an example user file of the data you will be sending over so that we can map it for you on our end. 

Here is what we need and recommend for an SFTP file:

  • The file needs to be in .csv format.
  • Our mandatory fields are email address, first name, last name, and employee id. These need to be in separate columns.
  • We require adding an employee id, however, we also highly recommend manager email and manager employee id.
  • We do not have a set format for headers. We only need to know what fields in TINYpulse your column headers should be mapping to.
  • Segment and each Attribute (if you use them) need to be in separate columns. Please let us know what column will be your Segment and which columns will be your Attributes.

We will get back to you with your SFTP connection details within 3-5 working days once we have your public key and example user file.

How to Set Up a SSH Key

Need instructions for how to generate an SSH key in Windows? Keep reading!

  1. Open up a Command Prompt
  2. Enter the following command: ssh-keygen -t rsa
    1. You will see the following response:
      Generating public/private rsa key pair.Enter file in which to save the key (C:\Users\[your username]/.ssh/id_rsa):
  3. All you need to do is press the Enter button on your keyboard so that it can create a file to save your SSH key for you
    1. You will see the following response:
      Created directory 'C:\Users\[your username}/.ssh'.
      Enter passphrase (empty for no passphrase): 
  4. You can enter in a passphrase to keep your SSH key more secure, or you can leave this blank and just press the Enter button on your keyboard
    1. You will see the following response:
      Enter same passphrase again:

  5. Type in your created passphrase if you created a passphrase or leave it blank if you did not create a passphrase and press the Enter button on your keyboard
  6. The following response will tell you where the identification and public key have been saved as well as show you the key fingerprint and the key’s randomart image
  7. Please send us the file that was saved in C:\Users\[your username]/.ssh (not the fingerprint)

How to Create an SFTP Connection

Need help with how to create an SFTP connection on your end?


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.