Versions Compared

Version Old Version 13 New Version Current
Changes made by

Adi A

Adi A

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Have you already integrated with CSV Courses? If yes, skip to the section: Customizable Fields

Table of Contents

...

Integration Flow

...

Client Requirements:

...

The CSV files must follow a specific naming convention. The name for the CSV file used in Integrations will be:

Code Block
<school _code>_<file _type>.csv

An example of a student-info file and course-info file name are:

...

The fields are as follows:

  • <school_code> is an a string used to denote your institution - typically an abbreviation of the institution name e.g. mcgill

  • <file_type> is "course-info" for the course data and "student-info" for the student data.

...

  • Subsequent file transfers do not need to be re-configured in our system if the column ordering remains the same.

  • If you change the order of the columns, or add columns, notify your Technical Project Manager.

...

FAQs

Expand
title1. Can I send just a delta of the file in a subsequent file transfer?

No, we do not accept deltas from a previous file. We require each file sent to include the full data for the student-info.csv.

Expand
title2. Do I need to include a header line?

Yes, it is required to include a header. Here's an example for the student-info.csv:

(eg. "student_unique_id"|"unique_id"|"email")

Expand
title3. If I don't have all the data for each field, how do I omit fields?

We prefer a user friendly name such as "No GPA Range". However, if that's not possible you may omit a field by using an empty string as the value (""). 

Expand
title4. If I omit fields, will it break the integration?

If omitting a required field, the record will be skipped. It will not break the whole integration, however all information tied to that record will not be processed.

If omitting an optional field, such as  ethnicity , the record will be processed and the integration will be successful. 

Expand
title5. How do you handle return carriages?

We handle return carriages ie. line breaks in our logic. There is no need to escape them using '\n'.

Expand
title6. What happens if there are duplicates in the file?

Our system skips duplicate records. The integrations are unaffected.

Expand
title7. Can I send the files every hour?

We accept any frequency of CSV file transfers to our SFTP server. However, our system checks for new files once every 4 hrs, so there is no improvement in performance from transferring files once every 4 hrs to once every hour.

Expand
title8. What is the lag time between new files being sent over, and when they begin to appear in the mobile app?

Our system will typically complete processing of any new files within 6 hrs of being received. The first import during the configuration phase may take longer than 6 hrs, but subsequent imports will typically be under 6 hrs.

Expand
title9. If I change the column order or add new columns, do I need to notify Ready Education?

Yes. If you change the order of the columns or add columns please reach out to your Customer Success Consultant or Technical Project Manager. 

If you'd like to add new columns (e.g. filters options to Dynamic Audiences), you can add those to the CSV file and notify Ready Education to have the new columns configured. 

We do not recommend changing the order of columns as it may break your integration. If you must change the order, please reach out to your Customer Success Consultant or Technical Project Manager immediately to let them know to reconfigure the integrations. 

Expand
title10. Can I manually send over CSV files to the SFTP server?

Yes, it is possible to manually upload the data. However, we recommend automating the process and sending files over at least every 24 hrs (up to 4x daily) to keep the data in sync and relevant.