Skip to main content

Data Integration Guide / Process (SFTP)

Walkthrough for SFTP integration.

Updated over 3 months ago

Welcome! This guide outlines the steps to successfully connect your Student Information System (SIS) to our platform using SFTP for secure data syncing. Please follow each step carefully to ensure a smooth integration.

Step 1: Receive Your SFTP Credentials

A member of our Data Integration team will contact you via email. This email will contain a secure, time-limited link (active for 7 days) with your unique SFTP credentials.

  • Important: Save these credentials securely, as they will be needed to establish your connection.

  • If someone else on your team is responsible for the SFTP setup, please forward the credentials to them directly.


Step 2: Review the Guidelines and Requirements

Before transmitting any files, review the following resources carefully.
Failure to read may result in significant delays.

  • Data Processing & Sync Guidelines
    Outlines formatting rules, sync frequency, file naming conventions, and general process expectations.

  • Data Fields for App SFTP Integrations
    Lists all accepted fields by user type (e.g., students, staff, etc.), including required and optional fields. This is especially important if you are using a custom file format.
    โ€‹


Step 3: Choose a File Format Approach

You have two options when preparing your data files:

  1. Use Our Provided Templates
    Recommended for a faster setup. These templates are preformatted to match our system requirements. SFTP Templates.

  2. Use Your Own Custom Files
    If you prefer to use your own structure, ensure your files contain all required fields and match the specifications outlined in Required SIS Data for App SFTP Integrations.


Step 4: Configure the SFTP Export in Your SIS

Log in to your SIS portal and set up an automated export of your user data to our secure SFTP server.
โ€‹

The SFTP connection information can be found in the email provided to you by the data integration specialists.
โ€‹

โ€‹Host/Server IP Address
Port

Connect using the credentials provided to you. This will come as a 1Password link which is only accessible via your email address. Each client is assigned a unique, secure folder for their data.

  • File Format: CSV (we also accept TXT but it's not preferable)

  • Frequency: Daily, nightly, or per your sync requirements

    • Data is processed nightly around 12:15 AM Central but we accept data 24/7

  • Security: Use SFTP (not FTP or FTPS)


Step 5: Notify Us Once Files Are Sent

Once your SIS is exporting files to our server, notify your assigned Data Integration Specialist. Our system does not send automatic alerts upon receiving data, so manual confirmation is required.

We will begin:

  • Mapping your data to our system

  • Validating fields and structure

  • Providing feedback if anything needs correction


Final Steps: Sync Activation

Once we verify that your data is complete and accurate, we will activate the sync. User data will then begin appearing in your dashboard as scheduled.

Did this answer your question?