Audiences Plus - Integration Guide

Ready Education integrates with CSV files to bring notifications based on targeted groups into the mobile app. To learn more about Dynamic Audiences, check out our Support Helpdesk: 

• What are Audiences?

• Creating a Dynamic Audience (once integration is set-up)

• Sending a Notification

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

Integration Flow

Client Requirements:

1. Downloads student population information into a CSV: student-info.csv

2. Transfers the CSV file to Ready Education's servers using SSH File Transfer Protocol Server (SFTP).

The CSV data is downloaded from your SIS - Student Information System e.g. Banner, PeopleSoft, Campus Management, etc. We can support any SIS system. 

Ready Education Configuration Requirements:

1. Provides access to the SFTP Server

2. Checks CSV files for accuracy and required fields 3. Configures the CSV files for Dynamic Audiences Integrations

Downloading the CSV files

Ready Education requires the Student Info CSV file to be downloaded from your system's Student Information System e.g. SIS per our requirements. Examples of SIS include Banner, PeopleSoft, Campus Management, Jenzabar, Colleague, etc. 

Naming Convention

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

<school code>_<file type>.csv

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

• mcgill_student-info.csv

• mcgill_course-info.csv

The fields are as follows:

• <school_code> is an 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.

The fields in the file name are separated by underscores ("_").

File Content, Text Delimiters, and Qualifiers

The CSV files must follow the below specifications to run successfully. Please ensure your files meet the below requirements before sending them through the SFTP server:

Requirements:

• [ ] Each file should contain all the data (not a delta from the previous file)

• [ ] Include headers and use the data field's label as the header name

  • (eg. "student_unique_id"|"course_unique_id"|"name"|"gender")

• [ ] Text fields are separated by a pipe character | or comma , 

• [ ] The contents of any text field is enclosed within double quotes (""). We do not accept single quotes. Text using double quotes can be escaped with a backspace (e.g. "The \"New\" Normal: Post-pandemic")

student-info.csv

Extending CSV Courses Integrations to Dynamic Audiences: Already integrated to our SFTP Server through the CSV Courses Integration? If yes, scroll down to the section Customizable Fields.

Required Fields

We require the CSV files to include the below required information for student info. Please see the description for the expected format of the required fields. 

Customizable Fields

The Dynamic Audience feature gives you full control over the fields you want to target. We recommend working with your Campus Cloud Administrator (end user of the Dynamic Audience feature) to discuss the best fields for your school. 

Custom fields requirements:

• Maximum of 100 customizable fields. A field is a grouping such as "Program of Study", "Ethnicity", "Dietary Restriction", etc.

• Maximum of 500 options per field. Each field, such as Program of Study has a maximum of 500 options.

• Data is in a "grouping" instead of individual attributes. For example, GPA needs be provided as groups of "1.0 - 1.5", "1.5 - 2.0", ... , "3.0 - 3.5" and "3.5 - 4.0". We don't accept individual GPAs such as "3.3334", "3.991", "2.832", etc.

Custom fields recommendations: 

• User Friendly Names. Recommended for the Title to be user friendly and readable. The Title will display to administrators creating the Dynamic Audiences in Campus Cloud (our administrative portal).

• Name missing data. Recommended to handle fields with no data. For example, if a student has no dietary restrictions consider sending the field over as "No Dietary Restrictions" instead of blank e.g. "" or with a dash "-". Every field displays to administrators and a blank or dash is less informative, and may cause confusion.

The below are suggested fields for your Dynamic Audiences integration. 

Academic

Student Success

Demographic

Financial Information