SFTP: General setup



  • the following can only be done after SFTP: Setup (Windows/macOS) is completed and you have access to the SFTP server.
  • "Contributor" refers to "user"


Once you have completed the SFTP setup for Windows or macOS and have access to the SFTP server, you will see three folders that are dedicated to you. These folders are:

  • config – needs to contain configuration information (more info here)
  • input – this is where you will place your data files
  • results – this is where the log and the output files are placed

In ALL cases, the config folder in the SFTP server needs to contain a file called setup.txt (Jostle creates a template of this file for you). It contains:


You just need to replace yourusername with the username and yourpassword with the password for a Jostle user account in your instance. (Jostle will have pre-populated the file with <dc> replaced by the name of your data center.)

NOTE—the username and password should be that of a Jostle user with System Administrator access. It cannot be an SSO-managed account or Google-managed account.

Recommended best practice is to use an Automation user account for this process. You can learn more about Automation users here.


Optional elements


Upload alerts

You can have an email sent upon failed uploads and/or on successful uploads. This is done by specifying the email addresses in the setup file as follows:

{"datacenter":"<dc>","username":"<name>","password": "<pwd>",
"failureEmail":"", "successEmail":""}

You can specify one or both email addresses or none. In both cases you can specify more than one email by separating the addresses with a comma. (e.g. 'failureEmail':','). The email will include the contents of the log.txt file. (To diagnose issues with email addresses you will need to review the contents of log.txt in the results folder.)


UTF-8 encoding

You can specify UTF-8 encoding by placing 'encoding':'UTF-8' in the file.

{"datacenter":"<dc>","username":"<name>","password": "<pwd>", "encoding":"UTF-8"}


Date format

You can specify the date format for Contributor imports by placing 'dateFormat' in the file. The default format is MM/DD/YYYY, other choices are DD/MM/YYYY and YYYY/MM/DD.

{"datacenter":"<dc>","username":"<name>","password": "<pwd>", "dateFormat":"DD/MM/YYYY"}


Add Username

You can generate a 'username' column with "addUsername", which can have values of true or false or a column name:


When this parameter is present and true, it will generate a 'username' column using the data in the 'workemail' column. This is helpful when the source system cannot output the same data in two columns, since it is very common for username=workemail in Jostle. If you set the value to a specific column name you must match the format and case exactly with the column name in the upload file (This helps if you are mapping column names).


Setting defaults

You can specify default values for columns that are empty:

{"fixedValues":{"col1":"value1", "col1":"value2", ...}}

where col1 is the name of a column that can exist in an upload file, and value1 becomes the default value for that field. The column does not need to exist in the file being uploaded, in which case the default will be applied if the user does Not already have a value in Jostle for that data field. If the column exists in the upload file, and has a value then the value in the file will be applied to the user, if no value in the file, then the previous rule applies.

If you use a mappings.csv file the columns need to be included there.

Chart uploads file names

If you are doing 2 part chart upload and you want ignore extra data at the end of the file name:


where <n> is the number of characters (including the file extension) at the end of the file name to ignore.

Contributors import

For the Contributors import case there are 2 additional optional elements that can be added to the setup file:


Where <method> is one of:

  • INVITE_NONE – no one
  • INVITE_NEW – new Contributors
  • INVITE_NOT_ACTIVATED - new Contributors and those not yet invited
  • INVITE_NOT_ACTIVATED_AND_EXPIRED - new Contributors, those not yet invited
  • INVITE_CUSTOM - as specified in import file

In the case of organizations using SSO or Google, the INVITE_NEW, INVITE_NOT_ACTIVATED, and INVITE_NOT_ACTIVATED_AND_EXPIRED methods will default to SSO (or Google). If you wish to force the invitation to be for a Jostle login (assuming it is enabled), then the file name needs to be changed to jostleContributorsInvitepwd<>.csv

The <language> value is used to set the language used in the invitation email and must be one of the languages supported by Jostle, e.g. 'ENGLISH','FRENCH',or 'GERMAN'. (You can contact to ask what languages are supported.) If this parameter is not included, English will be used.

The 'blanksOverwriteValues':'true' is used to overwrite/reset any previously entered data. Any blank field with a proper column heading will be overwritten with a blank value. Column headings missing from the CSV will be completely ignored - not "blanked" out. You can also include "NoBlanks" in a file name and blanksOverwriteValues will be set true for that one upload.


Continue here to learn about the SFTP server files and folder structure.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Please sign in to leave a comment.