SFTP: Data Connection and Transfer Overview

SFTP is only for records and lists. Images must be manually imported as zip files.

SFTP stands for Secure File Transfer Protocol in which one server can transfer files to another server. The SFTP connection ensures your server can automatically transfer files to Badge's servers. Badge's SFTP connection with the server will also act as an outbound connection where any updates in Badge will update in the client's server.

• Any modifications in the SFTP connection can potentially disconnect all integrations between servers. 
• Consult with your Badge project manager before making any changes in the files. 
  

When clients choose to use SFTP, data transfer is automated. To start, data is routinely and automatically transferring in and out using SFTP into Badge. Any changes made in a client's internal database or third-party information system will automatically update the lists in Badge. From there, clients are able to view updated records and images before printing a new ID card.

• You must be a Badge Owner or have been given permission as a Badge User to set up SFTP.

Setup SFTP Credentials

Transferring data using SFTP begins with creating SFTP credentials. SFTP credentials are important because clients will need to be authenticated before given access to sensitive data in a secure file directory.

• Contact your Badge project manager to obtain a SFTP credential.

Data In

Clients must follow data formatting requirements to ensure a successful import. Whether that is from an internal database or a third-party information system, data must cohere to formatting requirements.

• Data should be saved as a CSV file when transferring records in.
• Images should be saved as a ZIP file without any sub folders when transferring images in.
• Click here to read about the formatting requirements.

Once all data has been correctly formatted, clients can import the data using SFTP or an FTP app (e.g., WinSCP, FileZilla)

For timing and frequency, we recommend one daily upload either in beginning or end of the day. 

When clients begin sending requests to add and update files to the SFTP servers, Badge will receive the requests and complete them through a queue. The Badge dashboard will notify clients that data has completed importing. 

• Data files transferred using SFTP is routinely overwriting outdated data in Badge.
• Excluding/Removing/Deleting records from your CSV file before transferring data in Badge will not delete records in Badge. 
• To delete records in Badge, click here to delete records.

Data Out

In Badge, clients can either manually or automatically export data. The advantages of automating using SFTP ensures the data is the most up to date before the client can export. 

• Click here to learn more about manually exporting data in Badge.

Clients must set up a SFTP connection in Secure Share to automatically export data. In Secure Share, lists can have a separate location in the SFTP server specifically to export data. 

• Clients can transfer data out as CSV and Excel files to any file directory.
• Images exported from Badge to the SFTP server will be saved as single image files for each record.

Data Integration

• Click here to learn more about integrating ClassLink with Badge.
• Click here to learn more about integrating Clever with Badge.